1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Usage Specification

Update a usage specification

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2/usageSpecification/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : UsageSpecificationOracle
Title: UsageSpecificationOracle
Match All
Show Source
  • UsageSpecification
    Title: UsageSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecification":"#/components/schemas/UsageSpecification", "UsageSpecificationOracle":"#/components/schemas/UsageSpecificationOracle" } }
    The Usage Specification resource represents a set of usage characteristics and relationships.
  • type
Nested Schema : UsageSpecification
Type: object
Title: UsageSpecification
Discriminator: @type

Discriminator Values

The Usage Specification resource represents a set of usage characteristics and relationships.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : meteringRule
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : requestSpecification
Type: array
Show Source
  • RequestSpecificationRefOracle
    Title: RequestSpecificationRefOracle
    A list of request level specification references (RequestSpecificationRef [*]). A list of request level specifications related to this usage specification, and which will need to be satisfiable for corresponding usage instances.
Nested Schema : MeteringRule
Type: object
Title: MeteringRule
A metering rule
Show Source
Nested Schema : meteringExpression
Type: array
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : MeteringExpression
Type: object
Title: MeteringExpression
A metering expression
Show Source
Nested Schema : meteringExpressionRelationship
Type: object
Show Source
Nested Schema : value
A discrete value that the relationship can take on.
Match One Schema
Show Source
Nested Schema : MeteringExpressionRelationship
Type: object
Title: MeteringExpressionRelationship
An expression relationship
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : RequestSpecificationRefOracle
Type: object
Title: RequestSpecificationRefOracle
A list of request level specification references (RequestSpecificationRef [*]). A list of request level specifications related to this usage specification, and which will need to be satisfiable for corresponding usage instances.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : UsageSpecificationOracle
Title: UsageSpecificationOracle
Match All
Show Source
  • UsageSpecification
    Title: UsageSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecification":"#/components/schemas/UsageSpecification", "UsageSpecificationOracle":"#/components/schemas/UsageSpecificationOracle" } }
    The Usage Specification resource represents a set of usage characteristics and relationships.
  • type
Nested Schema : UsageSpecification
Type: object
Title: UsageSpecification
Discriminator: @type

Discriminator Values

The Usage Specification resource represents a set of usage characteristics and relationships.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : meteringRule
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : requestSpecification
Type: array
Show Source
  • RequestSpecificationRefOracle
    Title: RequestSpecificationRefOracle
    A list of request level specification references (RequestSpecificationRef [*]). A list of request level specifications related to this usage specification, and which will need to be satisfiable for corresponding usage instances.
Nested Schema : MeteringRule
Type: object
Title: MeteringRule
A metering rule
Show Source
Nested Schema : meteringExpression
Type: array
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : MeteringExpression
Type: object
Title: MeteringExpression
A metering expression
Show Source
Nested Schema : meteringExpressionRelationship
Type: object
Show Source
Nested Schema : value
A discrete value that the relationship can take on.
Match One Schema
Show Source
Nested Schema : MeteringExpressionRelationship
Type: object
Title: MeteringExpressionRelationship
An expression relationship
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : RequestSpecificationRefOracle
Type: object
Title: RequestSpecificationRefOracle
A list of request level specification references (RequestSpecificationRef [*]). A list of request level specifications related to this usage specification, and which will need to be satisfiable for corresponding usage instances.
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to update a usage specification by submitting a PATCH request on the REST resource using cURL. In this example, we will update the status of the usage specification to Ready to Publish.

curl -u username:password -X PATCH https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2/usageSpecification/Usage_Spec_4356

Example of Request Body

The following shows an example of the request body.

{
"lifecycleStatus": "Ready to Publish"
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "id": "Usage_Spec_4356",
    "name": "Prod_Usage",
    "description": "The usage specification for production.",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2/usageSpecification/Usage_Spec_4356",
    "lifecycleStatus": "Ready to Publish",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z",
        "endDateTime": "2021-02-20T16:42:23.000Z"
    },
    "@type": "UsageSpecificationOracle",
    "@baseType": "UsageSpecification",
    "created": "2020-11-12T10:13:17.000Z",
    "createdBy": "Administrator",
    "lastUpdate": "2020-11-12T10:13:17.000Z",
    "lastUpdatedBy": "Administrator",
    "version": "1.0",
    "usageSpecCharacteristic": [
        {
            "name": "availableSize",
            "description": "Available Size",
            "valueType": "STRING",
            "extensible": true,
            "configurable": true,
            "isInvoiceable": true,
            "isServiceId": true,
            "isTransient": true,
            "isUnique": true,
            "regex": "mrregex",
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2021-02-20T16:42:23.000Z"
            },
            "usageSpecCharacteristicValue": [
                {
                    "isDefault": true,
                    "unitOfMeasure": "string",
                    "validFor": {
                        "startDateTime": "2020-09-03T23:16:58.000Z",
                        "endDateTime": "2020-09-03T23:16:58.000Z"
                    },
                    "value": "string",
                    "valueFrom": "string",
                    "valueTo": "string",
                    "valueType": "STRING",
                    "rangeInterval": "OPEN",
                    "regex": "string",
                    "@type": "string",
                    "@baseType": "string",
                    "@schemaLocation": "string",
                    "default": true
                }
            ],
            "transient": true,
            "serviceId": true,
            "unique": true,
            "invoiceable": true
        }
    ],
    "project": {
        "id": "Pinnacle_Prod",
        "name": "Pinnacle Production Implementation"
    }
}
Back to Top