Get all service specifications
get
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification
Returns a list of service 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.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The list of service specifications was returned successfully.
Root Schema : schema
Type:
Show Source
array-
Array of:
ServiceSpecificationOracle
Title:
ServiceSpecificationOracle
Nested Schema : ServiceSpecificationOracle
Title:
ServiceSpecificationOracleMatch All
Show Source
-
object
ServiceSpecification
Title:
ServiceSpecificationDiscriminator:{ "propertyName":"@type", "mapping":{ "ServiceSpecification":"#/components/schemas/ServiceSpecification", "ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle" } }The 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
ServiceSpecificationOracle-allOf[1]
Nested Schema : ServiceSpecification
Type:
objectTitle:
ServiceSpecificationDiscriminator: @type
Discriminator Values
The 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
The base type of the service specification.
-
@schemaLocation: string
The URI of the schema that defines the service specification.
-
@type(required): string
The class type of the service specification.
-
attachment: array
attachment
A list of attachments associated with the service specification.
-
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:
30The ID of the service specification. -
isBundle: boolean
A boolean value that determines whether a service specification represents a single service specification (false) or a bundle of service specifications (true).
-
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the service specification.
-
lifecycleStatus: string
Indicates the current lifecycle status of the service specification.
-
name(required): string
A string. Name of the service specification.
- relatedParty: array relatedParty
-
resourceSpecification: array
resourceSpecification
A list of resource specifications associated with the service specification.
-
serviceLevelSpecification: array
serviceLevelSpecification
A list of service level specifications associated with the service specification.
-
serviceSpecCharacteristic: array
serviceSpecCharacteristic
A list of service specification characteristics associated with the service specification.
-
serviceSpecRelationship: array
serviceSpecRelationship
A list of service specification relationships associated with the service specification.
-
targetServiceSchema: object
TargetServiceSchema
Title:
TargetServiceSchemaThe reference object to the schema and type of target product which is described by product specification. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
A string. Service specification version.
Nested Schema : ServiceSpecificationOracle-allOf[1]
Type:
Show Source
object-
applicationName: string
The name of the application associated with the service specification.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created.
-
externalId: string
The ID of the external associated with the service specification.
-
lastUpdatedBy: string
The name of the person who updated.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
serviceCode: string
The service code associated with the service specification.
-
versionState: number
The version state of the Service Specification.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe 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.
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:
objectTitle:
ErrorThe 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.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
Examples
The following example shows how to get all service specifications by submitting a GET request on the REST resource using cURL.
curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/
Example of Response Body
The following shows an example of the response body.
[
{
"id": "SS-TXT-ROAMING",
"name": "Text Roaming SS",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-TXT-ROAMING",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-01-20T13:24:50.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-17T10:57:47.009Z",
"lastUpdatedBy": "booth",
"isBundle": false,
"@type": "ServiceSpecificationOracle",
"validFor": {
"startDateTime": "2024-09-03T00:00:00.000Z"
},
"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"
},
"serviceCode": "/service/telco/gsm/sms"
},
{
"id": "SS-TXT-ROAMING2",
"name": "Text Roaming SS2",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-TXT-ROAMING2",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-01-20T13:24:50.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-17T10:57:47.009Z",
"lastUpdatedBy": "booth",
"isBundle": false,
"@type": "ServiceSpecificationOracle",
"validFor": {
"startDateTime": "2024-09-03T00:00:00.000Z"
},
"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"
},
"serviceCode": "/service/telco/gsm/sms"
}
]