REST API Reference for Launch Cloud Service

Create or update an array of service specification

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/serviceSpecifications

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 50

Show Source

Array of: ServiceSpecificationOracle

Title: ServiceSpecificationOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceSpecificationOracle"
    },
    "minItems":"1",
    "maxItems":"50"
}

Nested Schema : ServiceSpecificationOracle

Title: ServiceSpecificationOracle

Match All

Show Source

object ServiceSpecification

Title: ServiceSpecification

Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecification":"#/components/schemas/ServiceSpecification", "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle" } }

ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
object type

{
    "title":"ServiceSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ServiceSpecification"
        },
        {
            "type":"object",
            "properties":{
                "serviceCode":{
                    "type":"string",
                    "description":"Code to service specification"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated"
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the Service Specification"
                }
            }
        }
    ]
}

Nested Schema : ServiceSpecification

Type: object

Title: ServiceSpecification

Discriminator: @type

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Service Specification"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Service Specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Service Specification"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            }
        },
        "serviceSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ServiceSpecCharacteristicOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecification":"#/components/schemas/ServiceSpecification",
            "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
        }
    }
}

ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.

Show Source

@baseType: string

Immediate base (class) type of the Service Specification
@schemaLocation: string

A link to the schema describing this Service Specification
@type: string

Class type of the Service Specification
attachment: array attachment
description: string

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

A string. Reference of the service specification.
id: string

Maximum Length: 30

A string. Unique identifier of the service specification.
isBundle: boolean

A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true).
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the service specification.
lifecycleStatus: string

A string. Used to indicate the current lifecycle status of the service specification.
name(required): string

A string. Name of the service specification.
relatedParty: array relatedParty
resourceSpecification: array resourceSpecification
serviceLevelSpecification: array serviceLevelSpecification
serviceSpecCharacteristic: array serviceSpecCharacteristic
serviceSpecRelationship: array serviceSpecRelationship
targetServiceSchema: object TargetServiceSchema

Title: TargetServiceSchema

The reference object to the schema and type of target product which is described by product specification
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

A string. Service specification version.

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Service Specification"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Service Specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Service Specification"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            }
        },
        "serviceSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ServiceSpecCharacteristicOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecification":"#/components/schemas/ServiceSpecification",
            "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

applicationName: string

name of the external application
created: string (date-time)

Date and time of creation
createdBy: string

name of the person who created
externalId: string

id of the external application
lastUpdatedBy: string

name of the person who updated
project: object ProjectRef

Title: ProjectRef

Project Reference
serviceCode: string

Code to service specification
versionState: number

Version state of the Service Specification

{
    "type":"object",
    "properties":{
        "serviceCode":{
            "type":"string",
            "description":"Code to service specification"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Service Specification"
        }
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Response

Supported Media Types

application/json

200 Response

Your request is successful and the resources have been created or updated.

Root Schema : schema

Type: array

Show Source

Array of: ServiceSpecificationOracle

Title: ServiceSpecificationOracle

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

Nested Schema : ServiceSpecificationOracle

Title: ServiceSpecificationOracle

Match All

Show Source

object ServiceSpecification

Title: ServiceSpecification

Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecification":"#/components/schemas/ServiceSpecification", "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle" } }

ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
object type

{
    "title":"ServiceSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ServiceSpecification"
        },
        {
            "type":"object",
            "properties":{
                "serviceCode":{
                    "type":"string",
                    "description":"Code to service specification"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated"
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the Service Specification"
                }
            }
        }
    ]
}

Nested Schema : ServiceSpecification

Type: object

Title: ServiceSpecification

Discriminator: @type

Discriminator Values

ServiceSpecification
ServiceSpecificationOracle

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Service Specification"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Service Specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Service Specification"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            }
        },
        "serviceSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ServiceSpecCharacteristicOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecification":"#/components/schemas/ServiceSpecification",
            "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
        }
    }
}

Show Source

@baseType: string

Immediate base (class) type of the Service Specification
@schemaLocation: string

A link to the schema describing this Service Specification
@type: string

Class type of the Service Specification
attachment: array attachment
description: string

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

A string. Reference of the service specification.
id: string

Maximum Length: 30

A string. Unique identifier of the service specification.
isBundle: boolean

A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true).
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the service specification.
lifecycleStatus: string

A string. Used to indicate the current lifecycle status of the service specification.
name(required): string

A string. Name of the service specification.
relatedParty: array relatedParty
resourceSpecification: array resourceSpecification
serviceLevelSpecification: array serviceLevelSpecification
serviceSpecCharacteristic: array serviceSpecCharacteristic
serviceSpecRelationship: array serviceSpecRelationship
targetServiceSchema: object TargetServiceSchema

Title: TargetServiceSchema

The reference object to the schema and type of target product which is described by product specification
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

A string. Service specification version.

{
    "title":"ServiceSpecification",
    "type":"object",
    "description":"ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the service specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the service specification."
        },
        "version":{
            "type":"string",
            "description":"A string. Service specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the service specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the service specification is."
        },
        "isBundle":{
            "type":"boolean",
            "description":"A boolean. isBundle determines whether a ServiceSpecification represents a single ServiceSpecification (false), or a bundle of ServiceSpecification (true)."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the service specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Service Specification"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Service Specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Service Specification"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the service specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "serviceLevelSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceLevelSpecificationRef"
            }
        },
        "serviceSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/ServiceSpecCharacteristicOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            }
        },
        "serviceSpecRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecRelationship"
            }
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "attachment":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttachmentRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecification":"#/components/schemas/ServiceSpecification",
            "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

applicationName: string

name of the external application
created: string (date-time)

Date and time of creation
createdBy: string

name of the person who created
externalId: string

id of the external application
lastUpdatedBy: string

name of the person who updated
project: object ProjectRef

Title: ProjectRef

Project Reference
serviceCode: string

Code to service specification
versionState: number

Version state of the Service Specification

{
    "type":"object",
    "properties":{
        "serviceCode":{
            "type":"string",
            "description":"Code to service specification"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Service Specification"
        }
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

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 : schema

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/Error"
            },
            {
                "$ref":"#/components/schemas/BulkError"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "Error":"#/components/schemas/Error",
                "BulkError":"#/components/schemas/BulkError"
            }
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

Error
BulkError

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "$ref":"#/components/schemas/BulkError"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error",
            "BulkError":"#/components/schemas/BulkError"
        }
    }
}

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

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

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

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

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "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":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

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

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

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "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":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

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

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

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "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":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@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

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

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

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "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":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following example shows how to create or update an array of service specification by submitting a put request on the REST resource using cURL.

cURL Command

curl -u username:password -X PUT \ 'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/serviceSpecifications' -H 'Content-Type: application/json' -D @put_servicespecs.json | json_pp

Example of Request Body

The following shows an example of the request body.

[
{
    "id": "TelcoGSM_Service_001",
    "name": "TelcoGSM_Service_001",
    "@type": "ServiceSpecificationOracle",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "description": "Service  description22 pacth it",
    "validFor": {
        "startDateTime": "2019-06-19T16:42:23.0Z",
        "endDateTime": "2022-08-19T16:42:23.0Z"
    },
    "project": {
        "id": "BulkDocProject",
        "name": "Bulk Doc Project"
    },
    "serviceSpecCharacteristic": [
        {
            "name": "ServiceSpecChar001",
            "description": "Test for service char",
            "validFor": {
                "startDateTime": "2019-06-19T16:42:23.0Z",
                "endDateTime": "2022-08-19T16:42:23.0Z"
            },
            "configurable": true,
            "valueType": "STRING",
            "extensible": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "serviceSpecCharacteristicValue": [
                {
                    "valueType": "STRING",
                    "isDefault": true,
                    "value": "Android Kitkat CATBURY",
                    "validFor": {
                        "startDateTime": "2019-06-19T16:42:23.0Z",
                        "endDateTime": "2022-08-19T16:42:23.0Z"
                    }
                }
            ]
        }
    ]
},
{
    "id": "TelcoGSM_Service_002",
    "name": "TelcoGSM_Service_002",
    "@type": "ServiceSpecificationOracle",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "description": "Service  description22 pacth it",
    "validFor": {
        "startDateTime": "2019-06-19T16:42:23.0Z",
        "endDateTime": "2022-08-19T16:42:23.0Z"
    },
    "project": {
        "id": "BulkDocProject",
        "name": "Bulk Doc Project"
    },
    "serviceSpecCharacteristic": [
        {
            "name": "ServiceSpecChar001",
            "description": "Test for service char",
            "validFor": {
                "startDateTime": "2019-06-19T16:42:23.0Z",
                "endDateTime": "2022-08-19T16:42:23.0Z"
            },
            "configurable": true,
            "valueType": "STRING",
            "extensible": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "serviceSpecCharacteristicValue": [
                {
                    "valueType": "STRING",
                    "isDefault": true,
                    "value": "Android Kitkat CATBURY",
                    "validFor": {
                        "startDateTime": "2019-06-19T16:42:23.0Z",
                        "endDateTime": "2022-08-19T16:42:23.0Z"
                    }
                }
            ]
        }
    ]
}
]

Example of Response Body

The following shows an example of the response body.

[
    {
        "id": "TelcoGSM_Service_001",
        "name": "TelcoGSM_Service_001",
        "description": "Service  description22 pacth it",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/serviceSpecifications/TelcoGSM_Service_001",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "isBundle": false,
        "@type": "ServiceSpecificationOracle",
        "validFor": {
            "startDateTime": "2019-06-19T16:42:23.0Z",
            "endDateTime": "2022-08-19T16:42:23.0Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "serviceSpecCharacteristic": [
            {
                "name": "ServiceSpecChar001",
                "description": "Test for service char",
                "valueType": "STRING",
                "extensible": false,
                "configurable": true,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2019-06-19T16:42:23.0Z",
                    "endDateTime": "2022-08-19T16:42:23.0Z"
                },
                "serviceSpecCharacteristicValue": [
                    {
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2019-06-19T16:42:23.0Z",
                            "endDateTime": "2022-08-19T16:42:23.0Z"
                        },
                        "valueType": "STRING",
                        "value": "Android Kitkat CATBURY"
                    }
                ]
            }
        ]
    },
    {
        "id": "TelcoGSM_Service_002",
        "name": "TelcoGSM_Service_002",
        "description": "Service  description22 pacth it",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/serviceSpecifications/TelcoGSM_Service_002",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "isBundle": false,
        "@type": "ServiceSpecificationOracle",
        "validFor": {
            "startDateTime": "2019-06-19T16:42:23.0Z",
            "endDateTime": "2022-08-19T16:42:23.0Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "serviceSpecCharacteristic": [
            {
                "name": "ServiceSpecChar001",
                "description": "Test for service char",
                "valueType": "STRING",
                "extensible": false,
                "configurable": true,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2019-06-19T16:42:23.0Z",
                    "endDateTime": "2022-08-19T16:42:23.0Z"
                },
                "serviceSpecCharacteristicValue": [
                    {
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2019-06-19T16:42:23.0Z",
                            "endDateTime": "2022-08-19T16:42:23.0Z"
                        },
                        "valueType": "STRING",
                        "value": "Android Kitkat CATBURY"
                    }
                ]
            }
        ]
    }
]