REST API Reference for Launch Cloud Service

Get all usage specifications

get

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

Returns a list of usage specifications that match the search criteria.

Request

Query Parameters

description: string

The description of the resource.
eligibleForProject: string

The project ID.
fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
id: string

The unique ID of the resource item.
lastUpdate: string

Filters resources by their last update date and time.
lifecycleStatus: string

The current lifecycle status of the resource.
limit: integer

The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
name: string

The name of the resource.
offset: string

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
project.id: string

The ID of the project for filtering resource results.
project.version: string

The project version for filtering entities.
validFor.endDateTime: string

The valid for end date time for filtering entities.
validFor.startDateTime: string

The valid for start date time for filtering entities.
version: string

The current version of the resource.
whereUsed: string

Whether to enrich objects with usedBy information.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The list of usage specifications was returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: UsageSpecificationOracle

Title: UsageSpecificationOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsageSpecificationOracle"
    }
}

Nested Schema : UsageSpecificationOracle

Title: UsageSpecificationOracle

Match All

Show Source

object 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.
object UsageSpecificationOracle-allOf[1]

{
    "title":"UsageSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageSpecification"
        },
        {
            "type":"object",
            "properties":{
                "usageCode":{
                    "type":"string",
                    "description":"The usage code associated with the usage specification."
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date and time when the usage specification was created."
                },
                "createdBy":{
                    "type":"string",
                    "description":"The user who created the usage specification."
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"The user who last updated the usage specification."
                },
                "meteringRule":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/MeteringRuleOracle"
                    },
                    "description":"A list of metering rules associated with the usage specification."
                },
                "requestSpecification":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/RequestSpecificationRefOracle"
                    },
                    "description":"A list of request specifications associated with the usage specification."
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef",
                    "description":"The project associated with the usage specification."
                },
                "externalId":{
                    "type":"string",
                    "description":"The external ID associated with the usage specification."
                },
                "applicationName":{
                    "type":"string",
                    "description":"The name of the application associated with the usage specification."
                },
                "versionState":{
                    "type":"number",
                    "description":"The version state of the usage specification."
                }
            },
            "required":[
                "meteringRule"
            ]
        }
    ]
}

Nested Schema : UsageSpecification

Type: object

Title: UsageSpecification

Discriminator: @type

{
    "title":"UsageSpecification",
    "type":"object",
    "description":"The Usage Specification resource represents a set of usage characteristics and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the usage specification."
        },
        "version":{
            "type":"string",
            "description":"The usage specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the usage specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the usage specification is."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Indicates the current lifecycle status of the usage specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the usage specification is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the usage specification."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the usage specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the usage specification."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the usage specification was last updated."
        },
        "usageSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageSpecRelationship"
            },
            "description":"A list of usage specification relationships associated with the usage specification."
        },
        "usageSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageSpecCharacteristicOracle"
            },
            "description":"A list of usage specification characteristics associated with the usage specification."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecification":"#/components/schemas/UsageSpecification",
            "UsageSpecificationOracle":"#/components/schemas/UsageSpecificationOracle"
        }
    }
}

The Usage Specification resource represents a set of usage characteristics and relationships.

Show Source

@baseType: string

The base type of the usage specification.
@schemaLocation: string

The URI of the schema that defines the usage specification.
@type(required): string

The class type of the usage specification.
description: string

A string. A narrative that explains in detail what the usage specification is.
href: string

The hyperlink reference to the usage specification.
id: string

Maximum Length: 30

The ID of the usage specification.
lastUpdate: string (date-time)

The date and time when the usage specification was last updated.
lifecycleStatus: string

Indicates the current lifecycle status of the usage specification.
name(required): string

A string. Name of the usage specification.
usageSpecCharacteristic: array usageSpecCharacteristic

A list of usage specification characteristics associated with the usage specification.
usageSpecRelationship: array usageSpecRelationship

A list of usage specification relationships associated with the usage specification.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The usage specification version.

{
    "title":"UsageSpecification",
    "type":"object",
    "description":"The Usage Specification resource represents a set of usage characteristics and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the usage specification."
        },
        "version":{
            "type":"string",
            "description":"The usage specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the usage specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the usage specification is."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Indicates the current lifecycle status of the usage specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the usage specification is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the usage specification."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the usage specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the usage specification."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the usage specification was last updated."
        },
        "usageSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageSpecRelationship"
            },
            "description":"A list of usage specification relationships associated with the usage specification."
        },
        "usageSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageSpecCharacteristicOracle"
            },
            "description":"A list of usage specification characteristics associated with the usage specification."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecification":"#/components/schemas/UsageSpecification",
            "UsageSpecificationOracle":"#/components/schemas/UsageSpecificationOracle"
        }
    }
}

Nested Schema : UsageSpecificationOracle-allOf[1]

Type: object

Show Source

applicationName: string

The name of the application associated with the usage specification.
created: string (date-time)

The date and time when the usage specification was created.
createdBy: string

The user who created the usage specification.
externalId: string

The external ID associated with the usage specification.
lastUpdatedBy: string

The user who last updated the usage specification.
meteringRule(required): array meteringRule

A list of metering rules associated with the usage specification.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
requestSpecification: array requestSpecification

A list of request specifications associated with the usage specification.
usageCode: string

The usage code associated with the usage specification.
versionState: number

The version state of the usage specification.

{
    "type":"object",
    "properties":{
        "usageCode":{
            "type":"string",
            "description":"The usage code associated with the usage specification."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the usage specification was created."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who created the usage specification."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the usage specification."
        },
        "meteringRule":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MeteringRuleOracle"
            },
            "description":"A list of metering rules associated with the usage specification."
        },
        "requestSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RequestSpecificationRefOracle"
            },
            "description":"A list of request specifications associated with the usage specification."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The project associated with the usage specification."
        },
        "externalId":{
            "type":"string",
            "description":"The external ID associated with the usage specification."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the usage specification."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the usage specification."
        }
    },
    "required":[
        "meteringRule"
    ]
}

Nested Schema : meteringRule

Type: array

A list of metering rules associated with the usage specification.

Show Source

Array of: object MeteringRule

Title: MeteringRule

The metering rule resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MeteringRuleOracle"
    },
    "description":"A list of metering rules associated with the usage specification."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : requestSpecification

Type: array

A list of request specifications associated with the usage specification.

Show Source

Array of: object 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RequestSpecificationRefOracle"
    },
    "description":"A list of request specifications associated with the usage specification."
}

Nested Schema : MeteringRule

Type: object

Title: MeteringRule

The metering rule resource.

Show Source

@baseType: string

The base type of the metering rule.
@schemaLocation: string

The URI of the schema that defines the metering rule.
@type(required): string

The class type of the metering rule.
description: string

A string. Description of the metering rule.
id(required): string

The ID of the metering rule.
meteringExpression: array meteringExpression

A list of metering expressions associated with the metering rule.
name: string

The name of the metering rule.
roundingMethod: string

The rounding applicable to the metering rule.
stringExpression: string

The metering Expression applicable to the metering rule.
unitOfMeasure: string

The unit of Measure of Usage.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

The validity period of the related party.

{
    "type":"object",
    "title":"MeteringRule",
    "description":"The metering rule resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the metering rule."
        },
        "name":{
            "type":"string",
            "description":"The name of the metering rule."
        },
        "description":{
            "type":"string",
            "description":"A string. Description of the metering rule."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle",
            "description":"The period for which the metering rule is valid."
        },
        "roundingMethod":{
            "type":"string",
            "description":"The rounding applicable to the metering rule."
        },
        "stringExpression":{
            "type":"string",
            "description":"The metering Expression applicable to the metering rule."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"The unit of Measure of Usage."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the metering rule."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the metering rule."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the metering rule."
        },
        "meteringExpression":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MeteringExpressionOracle"
            },
            "description":"A list of metering expressions associated with the metering rule."
        }
    },
    "required":[
        "id",
        "@type"
    ]
}

Nested Schema : meteringExpression

Type: array

A list of metering expressions associated with the metering rule.

Show Source

Array of: object MeteringExpression

Title: MeteringExpression

The metering expression resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MeteringExpressionOracle"
    },
    "description":"A list of metering expressions associated with the metering rule."
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

The validity period of the related party.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "description":"The validity period of the related party.",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : MeteringExpression

Type: object

Title: MeteringExpression

The metering expression resource.

Show Source

@baseType: string

The base type of the metering expression.
@schemaLocation: string

The URI of the schema that defines the metering expression.
@type(required): string

The class type of the metering expression.
expressionType(required): string

Allowed Values: [ "UNARY", "BINARY", "NUMERIC", "CHARACTERISTIC" ]

The type or classification of the metering expression. Valid values are UNARY, BINARY, NUMERIC, and CHARACTERISTIC.
id(required): string

The ID of the metering expression.
meteringExpressionRelationship: object meteringExpressionRelationship

A list of metering expression relationships associated with the metering expression.
operator: string

Allowed Values: [ "NOT EQUALS", "MULTIPLY", "ADD", "DIVIDE", "NOT", "EQUALS", "SUBTRACT" ]

The operator of the expression. Valid values are NOT EQUALS, MULTIPLY, ADD, DIVIDE, NOT, EQUALS, and SUBTRACT.
value: value

A discrete value that the relationship can take on.

{
    "type":"object",
    "title":"MeteringExpression",
    "description":"The metering expression resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the metering expression."
        },
        "operator":{
            "type":"string",
            "description":"The operator of the expression. Valid values are NOT EQUALS, MULTIPLY, ADD, DIVIDE, NOT, EQUALS, and SUBTRACT.",
            "enum":[
                "NOT EQUALS",
                "MULTIPLY",
                "ADD",
                "DIVIDE",
                "NOT",
                "EQUALS",
                "SUBTRACT"
            ]
        },
        "expressionType":{
            "type":"string",
            "description":"The type or classification of the metering expression. Valid values are UNARY, BINARY, NUMERIC, and CHARACTERISTIC.",
            "enum":[
                "UNARY",
                "BINARY",
                "NUMERIC",
                "CHARACTERISTIC"
            ]
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"object"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                }
            ],
            "description":"A discrete value that the relationship can take on."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the metering expression."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the metering expression."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the metering expression."
        },
        "meteringExpressionRelationship":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/MeteringExpressionRelationshipOracle"
            },
            "description":"A list of metering expression relationships associated with the metering expression."
        }
    },
    "required":[
        "id",
        "expressionType",
        "@type"
    ]
}

Nested Schema : meteringExpressionRelationship

Type: object

A list of metering expression relationships associated with the metering expression.

Show Source

Array of: object MeteringExpressionRelationship

Title: MeteringExpressionRelationship

The metering expression relationship resource.

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/MeteringExpressionRelationshipOracle"
    },
    "description":"A list of metering expression relationships associated with the metering expression."
}

Nested Schema : value

A discrete value that the relationship can take on.

Match One Schema

Show Source

string
object value-oneOf[1]
number
boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"object"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        }
    ],
    "description":"A discrete value that the relationship can take on."
}

Nested Schema : MeteringExpressionRelationship

Type: object

Title: MeteringExpressionRelationship

The metering expression relationship resource.

Show Source

@baseType: string

The base type of the metering expression relationship.
@schemaLocation: string

The URI of the schema that defines the metering expression relationship.
@type(required): string

The class type of the metering expression relationship.
id(required): string

The ID of the metering expression relationship.
name: string

The name of the metering expression relationship.
relationshipType(required): string

Allowed Values: [ "LEFT_HAND_SIDE", "RIGHT_HAND_SIDE" ]

The type or classification of the metering expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE.

{
    "type":"object",
    "title":"MeteringExpressionRelationship",
    "description":"The metering expression relationship resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the metering expression relationship."
        },
        "name":{
            "type":"string",
            "description":"The name of the metering expression relationship."
        },
        "relationshipType":{
            "type":"string",
            "description":"The type or classification of the metering expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE.",
            "enum":[
                "LEFT_HAND_SIDE",
                "RIGHT_HAND_SIDE"
            ]
        },
        "@type":{
            "type":"string",
            "description":"The class type of the metering expression relationship."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the metering expression relationship."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the metering expression relationship."
        }
    },
    "required":[
        "relationshipType",
        "id",
        "@type"
    ]
}

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

@baseType: string

The base type of the request specification reference.
@referredType(required): string

A string. The actual type of the target instance when needed for disambiguation.
@schemaLocation: string

The URI of the schema that defines the request specification reference.
@type(required): string

The class type of the request specification reference.
href: string

A string. The hyperlink to access a request specification.
id(required): string

The ID of the request specification reference.
name: string

A string. The name given to the target request specification instance.
specType(required): string

Allowed Values: [ "INITIATE", "UPDATE", "TERMINATE", "EVENT", "OFFLINE" ]

The type or classification of the request specification reference. Valid values are INITIATE, UPDATE, TERMINATE, EVENT, and OFFLINE.
version: string

A string. Version of the target request Specification.

{
    "type":"object",
    "title":"RequestSpecificationRefOracle",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the request specification reference."
        },
        "href":{
            "type":"string",
            "description":"A string. The hyperlink to access a request specification."
        },
        "name":{
            "type":"string",
            "description":"A string. The name given to the target request specification instance."
        },
        "version":{
            "type":"string",
            "description":"A string. Version of the target request Specification."
        },
        "specType":{
            "type":"string",
            "description":"The type or classification of the request specification reference. Valid values are INITIATE, UPDATE, TERMINATE, EVENT, and OFFLINE.",
            "enum":[
                "INITIATE",
                "UPDATE",
                "TERMINATE",
                "EVENT",
                "OFFLINE"
            ]
        },
        "@type":{
            "type":"string",
            "description":"The class type of the request specification reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the request specification reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the request specification reference."
        },
        "@referredType":{
            "type":"string",
            "description":"A string. The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id",
        "specType",
        "@type",
        "@referredType"
    ]
}

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.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list).
message: string

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to get all usage specifications by submitting a GET request on the REST resource using cURL.

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

Example of Response Body

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

[
{
    "id": "DBE_UsageSpec_GPRS",
    "name": "EventDelayedSessionTelcoGprs",
    "description": "UsageSpec for DBE models for EventDelayedSessionTelcoGprs",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2/usageSpecification/DBE_UsageSpec_GPRS",
    "lifecycleStatus": "In design",
    "@type": "UsageSpecificationOracle",
    "@baseType": "UsageSpecification",
    "created": "2025-01-20T13:24:14.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T10:50:26.004Z",
    "lastUpdatedBy": "booth",
    "version": "1.0",
    "project": {
        "id": "DBE_RI_ProdModel_PreSeed_PSP",
        "name": "DBE RI Product Model Preseed",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "meteringRule": [
        {
            "id": "Occurrence",
            "name": "Occurrence",
            "description": "Occurrence",
            "roundingMethod": "UP",
            "stringExpression": "(1)",
            "unitOfMeasure": "None",
            "@type": "MeteringRuleOracle",
            "meteringExpression": [
                {
                    "id": "contentType",
                    "expressionType": "NUMERIC",
                    "value": "1",
                    "@type": "MeteringExpressionOracle"
                }
            ]
        },
        {
            "id": "Volume",
            "name": "Volume",
            "description": "Volume",
            "roundingMethod": "UP",
            "stringExpression": "(1)",
            "unitOfMeasure": "None",
            "@type": "MeteringRuleOracle",
            "meteringExpression": [
                {
                    "id": "contentType",
                    "expressionType": "NUMERIC",
                    "value": "1",
                    "@type": "MeteringExpressionOracle"
                }
            ]
        },
        {
            "id": "Duration",
            "name": "Duration",
            "description": "Duration",
            "roundingMethod": "UP",
            "stringExpression": "(1)",
            "unitOfMeasure": "None",
            "@type": "MeteringRuleOracle",
            "meteringExpression": [
                {
                    "id": "contentType",
                    "expressionType": "NUMERIC",
                    "value": "1",
                    "@type": "MeteringExpressionOracle"
                }
            ]
        }
    ]
},
{
    "id": "DBE_UsageSpec_GSM",
    "name": "EventDelayedSessionTelcoGSM",
    "description": "UsageSpec for DBE models for EventDelayedSessionTelcoGSM",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2/usageSpecification/DBE_UsageSpec_GSM",
    "lifecycleStatus": "In design",
    "@type": "UsageSpecificationOracle",
    "@baseType": "UsageSpecification",
    "created": "2025-01-20T13:24:14.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T10:50:26.004Z",
    "lastUpdatedBy": "booth",
    "version": "1.0",
    "project": {
        "id": "DBE_RI_ProdModel_PreSeed_PSP",
        "name": "DBE RI Product Model Preseed",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "meteringRule": [
        {
            "id": "Occurrence",
            "name": "Occurrence",
            "description": "Occurrence",
            "roundingMethod": "UP",
            "stringExpression": "(1)",
            "unitOfMeasure": "None",
            "@type": "MeteringRuleOracle",
            "meteringExpression": [
                {
                    "id": "contentType",
                    "expressionType": "NUMERIC",
                    "value": "1",
                    "@type": "MeteringExpressionOracle"
                }
            ]
        },
        {
            "id": "Volume",
            "name": "Volume",
            "description": "Volume",
            "roundingMethod": "UP",
            "stringExpression": "(1)",
            "unitOfMeasure": "None",
            "@type": "MeteringRuleOracle",
            "meteringExpression": [
                {
                    "id": "contentType",
                    "expressionType": "NUMERIC",
                    "value": "1",
                    "@type": "MeteringExpressionOracle"
                }
            ]
        },
        {
            "id": "Duration",
            "name": "Duration",
            "description": "Duration",
            "roundingMethod": "UP",
            "stringExpression": "(1)",
            "unitOfMeasure": "None",
            "@type": "MeteringRuleOracle",
            "meteringExpression": [
                {
                    "id": "contentType",
                    "expressionType": "NUMERIC",
                    "value": "1",
                    "@type": "MeteringExpressionOracle"
                }
            ]
        }
    ]
}
]