Jump to

• Request
• Response
• Examples

Update a Service

patch

/service/{id}

Updates the Service that matches the specified ID. Update can be performed using merge-patch. Kindly note that ID and ServiceSpecification cannot be updated and must not be provided in the PATCH requests.

Merge Patch:

All attributes provided in the request will be updated with the given values. If designOnly flag is true, then service will be in designed state otherwise it moves to completed state. Service can be suspended/resumed/terminated using PATCH by providing the required "state" in input request. For suspend and resume service action, designOnly param is not required.

Attribute selection is enabled for all first-level attributes.

Optionally, use the expand parameter to specify any service relationships that you want to see details for. By default, you'll just see links for these.

Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.

Request

Path Parameters

• id(required): string
  The ID of the service to update.

Query Parameters

• depth: integer
  The depth of the expansion.

  Default Value: 0
• designOnly(required): boolean
  This flag is used to control activation flow of the service. When it is 'true', service is designed with patched attributes but it is not activated. When it is 'false', service is designed with patched attributes and sequentially Approve/Issue/Activate requests are executed and moves service state to active.
• expand: string
  The additional details to include in the response.
• fields: string
  The fields to include in the response.

Supported Media Types

• application/merge-patch+json

Request Body - application/merge-patch+json ()

The service to be updated

Root Schema : schema

Type: object

Service Class.

Show Source

• businessInteraction: object BusinessInteractionRef
• category: string
  Indicates if it is customer facing or resource facing service.
• description: string
  A free-text description for the service.
• effectiveDate: string (date-time)
  The date and time when the service changes goes to activate.
• endDate: string (date-time)
  The date and time when the service is no longer effective.
• externalIdentity: object ExternalIdentity
  An external identity.
• hasStarted: boolean
  Read Only: true

  Flag indicates that service is started.
• href: string
  Read Only: true

  The URI for the service class.
• id: string
  Read Only: true

  The ID of the service.
• isServiceEnabled: boolean
  Read Only: true

  If FALSE, this particular Service has NOT been enabled for use
• name: string
  The name of the service.
• place: array place
  The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources.
• relatedParty: array relatedParty
  A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.
• serviceCharacteristic: array serviceCharacteristic
  A list of characteristics that characterize this service (ServiceCharacteristic [*])
• serviceDate: string (date-time)
  Read Only: true

  Date and time when the service was created (whatever its status).
• serviceOrderItem: array serviceOrderItem
  A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service.
• serviceRelationship: array serviceRelationship
  A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).
• serviceSpecification: object Specification
  A specification.
• serviceType: string
  The business type of the service.
• startDate: string (date-time)
  The date and time when the service is started.
• state: string
  Allowed Values: [ "designed", "inactive", "active", "terminated", "pendingCancel", "cancelled", "pendingDisconnect", "cancelPendingDisconnect" ]

  Valid values for the lifecycle state of the service.
• supportingResource: array supportingResource
  A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS.
• supportingService: array supportingService
  A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).

{
    "type":"object",
    "description":"Service Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the service class.",
            "readOnly":true
        },
        "businessInteraction":{
            "$ref":"#/components/schemas/BusinessInteractionRef",
            "description":"A related Business Interaction. A related business interaction linked to a specific entity."
        },
        "category":{
            "type":"string",
            "description":"Indicates if it is customer facing or resource facing service."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the service."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is no longer effective."
        },
        "hasStarted":{
            "type":"boolean",
            "description":"Flag indicates that service is started.",
            "readOnly":true
        },
        "isServiceEnabled":{
            "type":"boolean",
            "description":"If FALSE, this particular Service has NOT been enabled for use",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "serviceDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time when the service was created (whatever its status).",
            "readOnly":true
        },
        "supportingResource":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceServiceRef"
            },
            "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is started."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyServiceRef"
            },
            "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
        },
        "serviceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            },
            "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
        },
        "serviceRelationship":{
            "type":"array",
            "description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).",
            "items":{
                "$ref":"#/components/schemas/ServiceRelationship"
            }
        },
        "serviceType":{
            "type":"string",
            "description":"The business type of the service."
        },
        "supportingService":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Service"
            },
            "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
        },
        "serviceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "state":{
            "$ref":"#/components/schemas/ServiceStateEnum"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceServiceRef"
            },
            "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
        },
        "externalIdentity":{
            "$ref":"#/components/schemas/ExternalIdentity"
        },
        "serviceOrderItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedServiceOrderItem"
            },
            "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service changes goes to activate."
        }
    }
}

Nested Schema : BusinessInteractionRef

Type: object

Show Source

• id: string
  The id of Business Interaction
• state: string
  The state of Business Interaction

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of Business Interaction"
        },
        "state":{
            "type":"string",
            "description":"The state of Business Interaction"
        }
    }
}

Nested Schema : ExternalIdentity

Type: object

An external identity.

Show Source

• externalArrangement: string
  Allowed Values: [ "LEASED_IN", "FEDERATED", "LEASED_OUT", "SHARED" ]

  The type of federation model between UIM and the external party for the given entity.
• externalManagementDomain: string
  The external system, domain name, party, or participant in a federation solution.
• externalName: string
  The business-meaningful name of the business entity.
• externalObjectId: string
  The ID for a business entity.

{
    "type":"object",
    "description":"An external identity.",
    "properties":{
        "externalObjectId":{
            "type":"string",
            "description":"The ID for a business entity."
        },
        "externalName":{
            "type":"string",
            "description":"The business-meaningful name of the business entity."
        },
        "externalManagementDomain":{
            "type":"string",
            "description":"The external system, domain name, party, or participant in a federation solution."
        },
        "externalArrangement":{
            "type":"string",
            "description":"The type of federation model between UIM and the external party for the given entity.",
            "enum":[
                "LEASED_IN",
                "FEDERATED",
                "LEASED_OUT",
                "SHARED"
            ]
        }
    }
}

Nested Schema : place

Type: array

The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources.

Show Source

• Array of: PlaceServiceRef
  The place reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceServiceRef"
    },
    "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
}

Nested Schema : relatedParty

Type: array

A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.

Show Source

• Array of: RelatedPartyServiceRef
  The party reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyServiceRef"
    },
    "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
}

Nested Schema : serviceCharacteristic

Type: array

A list of characteristics that characterize this service (ServiceCharacteristic [*])

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    },
    "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
}

Nested Schema : serviceOrderItem

Type: array

A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service.

Show Source

• Array of: object RelatedServiceOrderItem
  The service order item which triggered service creation/change/termination.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedServiceOrderItem"
    },
    "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
}

Nested Schema : serviceRelationship

Type: array

A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).

Show Source

• Array of: object ServiceRelationship
  Describes links with services of the same category (useful for bundled services).

{
    "type":"array",
    "description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).",
    "items":{
        "$ref":"#/components/schemas/ServiceRelationship"
    }
}

Nested Schema : Specification

Type: object

A specification.

Show Source

• description: string
  Details about the specification.
• endDate: string (date-time)
  The date and time when the specification ends.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• href: string (uri)
  The URI for the specification.
• id(required): string
  The ID of the specification, which is the same as the name of the specification.
• name: string
  The name of the specification.
• startDate: string (date-time)
  The date and time when the specification starts.
• version: string
  The version of the specification, which is always 1.

{
    "type":"object",
    "description":"A specification.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the specification, which is the same as the name of the specification."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the specification."
        },
        "name":{
            "type":"string",
            "description":"The name of the specification."
        },
        "description":{
            "type":"string",
            "description":"Details about the specification."
        },
        "version":{
            "type":"string",
            "description":"The version of the specification, which is always <b>1</b>."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification starts."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification ends."
        }
    }
}

Nested Schema : supportingResource

Type: array

A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS.

Show Source

• Array of: ResourceServiceRef
  The resource reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceServiceRef"
    },
    "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
}

Nested Schema : supportingService

Type: array

A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).

Show Source

• Array of: object schema
  Service Class.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Service"
    },
    "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
}

Nested Schema : PlaceServiceRef

The place reference on a service.

Match All

Show Source

• object PlaceRef
  A place to associate with the resource/service.
• object PlaceServiceRef-allOf[1]

{
    "description":"The place reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PlaceRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "resourceName":{
                    "type":"string",
                    "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "latitude":{
                    "type":"string",
                    "description":"Latitude of the place."
                },
                "longitude":{
                    "type":"string",
                    "description":"Longitude of the place."
                },
                "placeSpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "placeCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the place."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the place."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the place."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the place which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : PlaceServiceRef-allOf[1]

Type: object

Show Source

• assignmentState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• configItemDisplayName: string
  The config item display name of the place which is editable from UI.
• configItemId: string
  The config item id of the place.
• configItemName: string
  The config item name of the place.
• consumerName: string
  The name of the service consumer.
• latitude: string
  Latitude of the place.
• longitude: string
  Longitude of the place.
• placeCharacteristic: array placeCharacteristic
  The list of characteristics for the place.
• placeSpecification: object Specification
  A specification.
• referenceState: string
  Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]

  The list of valid values for reference state.
• referenceType: string
  Allowed Values: [ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]

  Valid values for the list of supported reference types.
• resourceName: string
  The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "resourceName":{
            "type":"string",
            "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "latitude":{
            "type":"string",
            "description":"Latitude of the place."
        },
        "longitude":{
            "type":"string",
            "description":"Longitude of the place."
        },
        "placeSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "placeCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the place."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the place."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the place."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the place which is editable from UI."
        }
    }
}

Nested Schema : placeCharacteristic

Type: array

The list of characteristics for the place.

Show Source

• Array of: object Characteristic
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the place."
}

Nested Schema : Characteristic

Type: object

A characteristic of an object or entity represented by a name-value pair.

Show Source

• @schemaLocation: string (uri)
  The URI for the JSON Schema file that defines additional attributes and relationships.
• @type: string
  The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the valueType is an object.
• name(required): string
  The name of the characteristic.
• value(required): object value
  The value of the characteristic.
• valueType: string
  Allowed Values: [ "ALPHANUMERIC", "NUMERIC", "BOOLEAN", "DATE", "OBJECT", "URL" ]

  The data type for the characteristics's value.

{
    "type":"object",
    "description":"A characteristic of an object or entity represented by a name-value pair.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"The data type for the characteristics's value.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC",
                "BOOLEAN",
                "DATE",
                "OBJECT",
                "URL"
            ]
        },
        "value":{
            "type":"object",
            "description":"The value of the characteristic."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI for the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the <b>valueType</b> is an object."
        }
    }
}

Nested Schema : value

Type: object

The value of the characteristic.

Nested Schema : RelatedPartyServiceRef

The party reference on a service.

Match All

Show Source

• object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• object RelatedPartyServiceRef-allOf[1]

{
    "description":"The party reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "partySpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "partyCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the party."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the party."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the party."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the party which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : RelatedPartyRef

Type: object

A related party, which defines a party or party role linked to a specific entity.

Show Source

• @referredType: string
  Concrete Type of the Party, in case of dis-ambiguity. Default is 'Party'.
• href: string (uri)
  The URI for the related party.
• id: string
  The ID of the related party.
• name: string
  The name of the related party.
• role: string
  The role of the related party.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is 'Party'."
        }
    }
}

Nested Schema : RelatedPartyServiceRef-allOf[1]

Type: object

Show Source

• configItemDisplayName: string
  The config item display name of the party which is editable from UI.
• configItemId: string
  The config item id of the party.
• configItemName: string
  The config item name of the party.
• consumerName: string
  The name of the service consumer.
• partyCharacteristic: array partyCharacteristic
  The list of characteristics for the party.
• partySpecification: object Specification
  A specification.
• referenceState: string
  Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]

  The list of valid values for reference state.
• referenceType: string
  Allowed Values: [ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]

  Valid values for the list of supported reference types.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "partySpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "partyCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the party."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the party."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the party."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the party which is editable from UI."
        }
    }
}

Nested Schema : partyCharacteristic

Type: array

The list of characteristics for the party.

Show Source

• Array of: object Characteristic
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the party."
}

Nested Schema : ServiceCharacteristic

The service characteristic details.

Match All

Show Source

• object Characteristic
  A characteristic of an object or entity represented by a name-value pair.
• object ServiceCharacteristic-allOf[1]

{
    "description":"The service characteristic details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Characteristic"
        },
        {
            "type":"object",
            "properties":{
                "serviceName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "serviceSpecName":{
                    "type":"string",
                    "description":"The specification name of service.Required only for creation of the service."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the service characteristic."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the service characteristic."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the service characteristic which is editable from UI."
                },
                "configItemPath":{
                    "type":"string",
                    "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
                }
            }
        }
    ]
}

Nested Schema : ServiceCharacteristic-allOf[1]

Type: object

Show Source

• configItemDisplayName: string
  The config item display name of the service characteristic which is editable from UI.
• configItemId: string
  The config item id of the service characteristic.
• configItemName: string
  The config item name of the service characteristic.
• configItemPath: string
  The path of the config item's property. Its value can be get from design studio catridges where this property was designed.
• serviceName: string
  The name of the service consumer.
• serviceSpecName: string
  The specification name of service.Required only for creation of the service.

{
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "serviceSpecName":{
            "type":"string",
            "description":"The specification name of service.Required only for creation of the service."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the service characteristic."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the service characteristic."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the service characteristic which is editable from UI."
        },
        "configItemPath":{
            "type":"string",
            "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
        }
    }
}

Nested Schema : RelatedServiceOrderItem

Type: object

The service order item which triggered service creation/change/termination.

Show Source

• itemAction: string
  Allowed Values: [ "add", "modify", "delete", "noChange" ]

  Valid values for the lifecycle state of the orderItemAction.
• itemId: string
  Identifier of the order item where the service was managed.
• role: string
  Role of the service order item for this service.
• serviceOrderHref: string
  Reference of the related entity.
• serviceOrderId: string
  Unique identifier of a related entity.

{
    "type":"object",
    "required":[
        "itemId, serviceOrderId"
    ],
    "description":"The service order item which triggered service creation/change/termination.",
    "properties":{
        "itemAction":{
            "$ref":"#/components/schemas/OrderItemActionEnum"
        },
        "itemId":{
            "type":"string",
            "description":"Identifier of the order item where the service was managed."
        },
        "role":{
            "type":"string",
            "description":"Role of the service order item for this service."
        },
        "serviceOrderHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "serviceOrderId":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        }
    }
}

Nested Schema : ServiceRelationship

Type: object

Describes links with services of the same category (useful for bundled services).

Show Source

• relationshipType(required): string
  The type of relationship (e.g. depends on, enables)
• service(required): object schema
  Service Class.
• serviceRelationshipCharacteristic: array serviceRelationshipCharacteristic

{
    "required":[
        "relationshipType",
        "service"
    ],
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The type of relationship (e.g. depends on, enables)"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "serviceRelationshipCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            }
        }
    },
    "description":"Describes links with services of the same category (useful for bundled services)."
}

Nested Schema : serviceRelationshipCharacteristic

Type: array

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

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

Nested Schema : ResourceServiceRef

The resource reference on a service.

Match All

Show Source

• object ResourceRef
• object ResourceServiceRef-allOf[1]

{
    "description":"The resource reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceRef"
        },
        {
            "type":"object",
            "properties":{
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "expandResource":{
                    "$ref":"#/components/schemas/ResourceBase"
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the resource."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the resource."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the resource which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : ResourceRef

Type: object

Show Source

• @referredType: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• href: string
  Read Only: true

  Reference of the supporting resource.
• id: string
  Unique identifier of the supporting resource.
• name: string
  Name of the resource supporting the service.

{
    "type":"object",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the supporting resource."
        },
        "href":{
            "type":"string",
            "description":"Reference of the supporting resource.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the resource supporting the service."
        },
        "@referredType":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        }
    }
}

Nested Schema : ResourceServiceRef-allOf[1]

Type: object

Show Source

• assignmentState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• configItemDisplayName: string
  The config item display name of the resource which is editable from UI.
• configItemId: string
  The config item id of the resource.
• configItemName: string
  The config item name of the resource.
• consumerName: string
  The name of the service consumer.
• expandResource: object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• referenceState: string
  Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]

  The list of valid values for reference state.

{
    "type":"object",
    "properties":{
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "expandResource":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the resource."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the resource."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the resource which is editable from UI."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : externalIdentity

Type: object

Read Only: true

The external identity details for the federated resource.

Match All

Show Source

• object ExternalIdentity
  An external identity.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExternalIdentity"
        }
    ],
    "description":"The external identity details for the federated resource.",
    "readOnly":true
}

Nested Schema : place

Type: array

The list of associated geographic places.

Show Source

• Array of: object PlaceRef
  A place to associate with the resource/service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceRef"
    },
    "description":"The list of associated geographic places."
}

Nested Schema : resourceCharacteristic

Type: array

The list of characteristics for the resource.

Show Source

• Array of: object Characteristic
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the resource."
}

Nested Schema : resourceRelationship

Type: array

The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.

Show Source

• Array of: object ResourceRelationship
  A relationship to a resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRelationship"
    },
    "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
}

Nested Schema : ResourceRelationship

Type: object

A relationship to a resource.

Show Source

• fromRole: string
  The role name for the from-resource. Applies only to INVOLVE relationship types.
• relationshipType: string
  Allowed Values: [ "ASSOCIATES", "MAPPEDTO", "PARENT", "CHILD", "INVOLVE", "ASSIGN", "CONSUMER" ]

  The list of valid values for relationship type.
• resourceRef: object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• toRole: string
  The role name for the to-resource. Applies only to INVOLVE relationship types.

{
    "type":"object",
    "description":"A relationship to a resource.",
    "properties":{
        "relationshipType":{
            "$ref":"#/components/schemas/RelationshipTypeEnum"
        },
        "resourceRef":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "fromRole":{
            "type":"string",
            "description":"The role name for the from-resource. Applies only to INVOLVE relationship types."
        },
        "toRole":{
            "type":"string",
            "description":"The role name for the to-resource. Applies only to INVOLVE relationship types."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The service was updated successfully.

Body ()

Root Schema : schema

Type: object

Service Class.

Show Source

• businessInteraction: object BusinessInteractionRef
• category: string
  Indicates if it is customer facing or resource facing service.
• description: string
  A free-text description for the service.
• effectiveDate: string (date-time)
  The date and time when the service changes goes to activate.
• endDate: string (date-time)
  The date and time when the service is no longer effective.
• externalIdentity: object ExternalIdentity
  An external identity.
• hasStarted: boolean
  Read Only: true

  Flag indicates that service is started.
• href: string
  Read Only: true

  The URI for the service class.
• id: string
  Read Only: true

  The ID of the service.
• isServiceEnabled: boolean
  Read Only: true

  If FALSE, this particular Service has NOT been enabled for use
• name: string
  The name of the service.
• place: array place
  The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources.
• relatedParty: array relatedParty
  A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.
• serviceCharacteristic: array serviceCharacteristic
  A list of characteristics that characterize this service (ServiceCharacteristic [*])
• serviceDate: string (date-time)
  Read Only: true

  Date and time when the service was created (whatever its status).
• serviceOrderItem: array serviceOrderItem
  A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service.
• serviceRelationship: array serviceRelationship
  A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).
• serviceSpecification: object Specification
  A specification.
• serviceType: string
  The business type of the service.
• startDate: string (date-time)
  The date and time when the service is started.
• state: string
  Allowed Values: [ "designed", "inactive", "active", "terminated", "pendingCancel", "cancelled", "pendingDisconnect", "cancelPendingDisconnect" ]

  Valid values for the lifecycle state of the service.
• supportingResource: array supportingResource
  A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS.
• supportingService: array supportingService
  A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).

{
    "type":"object",
    "description":"Service Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the service class.",
            "readOnly":true
        },
        "businessInteraction":{
            "$ref":"#/components/schemas/BusinessInteractionRef",
            "description":"A related Business Interaction. A related business interaction linked to a specific entity."
        },
        "category":{
            "type":"string",
            "description":"Indicates if it is customer facing or resource facing service."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the service."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is no longer effective."
        },
        "hasStarted":{
            "type":"boolean",
            "description":"Flag indicates that service is started.",
            "readOnly":true
        },
        "isServiceEnabled":{
            "type":"boolean",
            "description":"If FALSE, this particular Service has NOT been enabled for use",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "serviceDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time when the service was created (whatever its status).",
            "readOnly":true
        },
        "supportingResource":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceServiceRef"
            },
            "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is started."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyServiceRef"
            },
            "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
        },
        "serviceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            },
            "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
        },
        "serviceRelationship":{
            "type":"array",
            "description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).",
            "items":{
                "$ref":"#/components/schemas/ServiceRelationship"
            }
        },
        "serviceType":{
            "type":"string",
            "description":"The business type of the service."
        },
        "supportingService":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Service"
            },
            "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
        },
        "serviceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "state":{
            "$ref":"#/components/schemas/ServiceStateEnum"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceServiceRef"
            },
            "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
        },
        "externalIdentity":{
            "$ref":"#/components/schemas/ExternalIdentity"
        },
        "serviceOrderItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedServiceOrderItem"
            },
            "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service changes goes to activate."
        }
    }
}

Nested Schema : BusinessInteractionRef

Type: object

Show Source

• id: string
  The id of Business Interaction
• state: string
  The state of Business Interaction

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of Business Interaction"
        },
        "state":{
            "type":"string",
            "description":"The state of Business Interaction"
        }
    }
}

Nested Schema : ExternalIdentity

Type: object

An external identity.

Show Source

• externalArrangement: string
  Allowed Values: [ "LEASED_IN", "FEDERATED", "LEASED_OUT", "SHARED" ]

  The type of federation model between UIM and the external party for the given entity.
• externalManagementDomain: string
  The external system, domain name, party, or participant in a federation solution.
• externalName: string
  The business-meaningful name of the business entity.
• externalObjectId: string
  The ID for a business entity.

{
    "type":"object",
    "description":"An external identity.",
    "properties":{
        "externalObjectId":{
            "type":"string",
            "description":"The ID for a business entity."
        },
        "externalName":{
            "type":"string",
            "description":"The business-meaningful name of the business entity."
        },
        "externalManagementDomain":{
            "type":"string",
            "description":"The external system, domain name, party, or participant in a federation solution."
        },
        "externalArrangement":{
            "type":"string",
            "description":"The type of federation model between UIM and the external party for the given entity.",
            "enum":[
                "LEASED_IN",
                "FEDERATED",
                "LEASED_OUT",
                "SHARED"
            ]
        }
    }
}

Nested Schema : place

Type: array

The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources.

Show Source

• Array of: PlaceServiceRef
  The place reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceServiceRef"
    },
    "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
}

Nested Schema : relatedParty

Type: array

A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.

Show Source

• Array of: RelatedPartyServiceRef
  The party reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyServiceRef"
    },
    "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
}

Nested Schema : serviceCharacteristic

Type: array

A list of characteristics that characterize this service (ServiceCharacteristic [*])

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    },
    "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
}

Nested Schema : serviceOrderItem

Type: array

A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service.

Show Source

• Array of: object RelatedServiceOrderItem
  The service order item which triggered service creation/change/termination.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedServiceOrderItem"
    },
    "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
}

Nested Schema : serviceRelationship

Type: array

A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).

Show Source

• Array of: object ServiceRelationship
  Describes links with services of the same category (useful for bundled services).

{
    "type":"array",
    "description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).",
    "items":{
        "$ref":"#/components/schemas/ServiceRelationship"
    }
}

Nested Schema : Specification

Type: object

A specification.

Show Source

• description: string
  Details about the specification.
• endDate: string (date-time)
  The date and time when the specification ends.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• href: string (uri)
  The URI for the specification.
• id(required): string
  The ID of the specification, which is the same as the name of the specification.
• name: string
  The name of the specification.
• startDate: string (date-time)
  The date and time when the specification starts.
• version: string
  The version of the specification, which is always 1.

{
    "type":"object",
    "description":"A specification.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the specification, which is the same as the name of the specification."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the specification."
        },
        "name":{
            "type":"string",
            "description":"The name of the specification."
        },
        "description":{
            "type":"string",
            "description":"Details about the specification."
        },
        "version":{
            "type":"string",
            "description":"The version of the specification, which is always <b>1</b>."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification starts."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification ends."
        }
    }
}

Nested Schema : supportingResource

Type: array

A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS.

Show Source

• Array of: ResourceServiceRef
  The resource reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceServiceRef"
    },
    "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
}

Nested Schema : supportingService

Type: array

A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).

Show Source

• Array of: object schema
  Service Class.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Service"
    },
    "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
}

Nested Schema : PlaceServiceRef

The place reference on a service.

Match All

Show Source

• object PlaceRef
  A place to associate with the resource/service.
• object PlaceServiceRef-allOf[1]

{
    "description":"The place reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PlaceRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "resourceName":{
                    "type":"string",
                    "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "latitude":{
                    "type":"string",
                    "description":"Latitude of the place."
                },
                "longitude":{
                    "type":"string",
                    "description":"Longitude of the place."
                },
                "placeSpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "placeCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the place."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the place."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the place."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the place which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : PlaceServiceRef-allOf[1]

Type: object

Show Source

• assignmentState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• configItemDisplayName: string
  The config item display name of the place which is editable from UI.
• configItemId: string
  The config item id of the place.
• configItemName: string
  The config item name of the place.
• consumerName: string
  The name of the service consumer.
• latitude: string
  Latitude of the place.
• longitude: string
  Longitude of the place.
• placeCharacteristic: array placeCharacteristic
  The list of characteristics for the place.
• placeSpecification: object Specification
  A specification.
• referenceState: string
  Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]

  The list of valid values for reference state.
• referenceType: string
  Allowed Values: [ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]

  Valid values for the list of supported reference types.
• resourceName: string
  The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "resourceName":{
            "type":"string",
            "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "latitude":{
            "type":"string",
            "description":"Latitude of the place."
        },
        "longitude":{
            "type":"string",
            "description":"Longitude of the place."
        },
        "placeSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "placeCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the place."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the place."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the place."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the place which is editable from UI."
        }
    }
}

Nested Schema : placeCharacteristic

Type: array

The list of characteristics for the place.

Show Source

• Array of: object Characteristic
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the place."
}

Nested Schema : Characteristic

Type: object

A characteristic of an object or entity represented by a name-value pair.

Show Source

• @schemaLocation: string (uri)
  The URI for the JSON Schema file that defines additional attributes and relationships.
• @type: string
  The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the valueType is an object.
• name(required): string
  The name of the characteristic.
• value(required): object value
  The value of the characteristic.
• valueType: string
  Allowed Values: [ "ALPHANUMERIC", "NUMERIC", "BOOLEAN", "DATE", "OBJECT", "URL" ]

  The data type for the characteristics's value.

{
    "type":"object",
    "description":"A characteristic of an object or entity represented by a name-value pair.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"The data type for the characteristics's value.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC",
                "BOOLEAN",
                "DATE",
                "OBJECT",
                "URL"
            ]
        },
        "value":{
            "type":"object",
            "description":"The value of the characteristic."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI for the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the <b>valueType</b> is an object."
        }
    }
}

Nested Schema : value

Type: object

The value of the characteristic.

Nested Schema : RelatedPartyServiceRef

The party reference on a service.

Match All

Show Source

• object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• object RelatedPartyServiceRef-allOf[1]

{
    "description":"The party reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "partySpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "partyCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the party."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the party."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the party."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the party which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : RelatedPartyRef

Type: object

A related party, which defines a party or party role linked to a specific entity.

Show Source

• @referredType: string
  Concrete Type of the Party, in case of dis-ambiguity. Default is 'Party'.
• href: string (uri)
  The URI for the related party.
• id: string
  The ID of the related party.
• name: string
  The name of the related party.
• role: string
  The role of the related party.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is 'Party'."
        }
    }
}

Nested Schema : RelatedPartyServiceRef-allOf[1]

Type: object

Show Source

• configItemDisplayName: string
  The config item display name of the party which is editable from UI.
• configItemId: string
  The config item id of the party.
• configItemName: string
  The config item name of the party.
• consumerName: string
  The name of the service consumer.
• partyCharacteristic: array partyCharacteristic
  The list of characteristics for the party.
• partySpecification: object Specification
  A specification.
• referenceState: string
  Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]

  The list of valid values for reference state.
• referenceType: string
  Allowed Values: [ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]

  Valid values for the list of supported reference types.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "partySpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "partyCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the party."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the party."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the party."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the party which is editable from UI."
        }
    }
}

Nested Schema : partyCharacteristic

Type: array

The list of characteristics for the party.

Show Source

• Array of: object Characteristic
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the party."
}

Nested Schema : ServiceCharacteristic

The service characteristic details.

Match All

Show Source

• object Characteristic
  A characteristic of an object or entity represented by a name-value pair.
• object ServiceCharacteristic-allOf[1]

{
    "description":"The service characteristic details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Characteristic"
        },
        {
            "type":"object",
            "properties":{
                "serviceName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "serviceSpecName":{
                    "type":"string",
                    "description":"The specification name of service.Required only for creation of the service."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the service characteristic."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the service characteristic."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the service characteristic which is editable from UI."
                },
                "configItemPath":{
                    "type":"string",
                    "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
                }
            }
        }
    ]
}

Nested Schema : ServiceCharacteristic-allOf[1]

Type: object

Show Source

• configItemDisplayName: string
  The config item display name of the service characteristic which is editable from UI.
• configItemId: string
  The config item id of the service characteristic.
• configItemName: string
  The config item name of the service characteristic.
• configItemPath: string
  The path of the config item's property. Its value can be get from design studio catridges where this property was designed.
• serviceName: string
  The name of the service consumer.
• serviceSpecName: string
  The specification name of service.Required only for creation of the service.

{
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "serviceSpecName":{
            "type":"string",
            "description":"The specification name of service.Required only for creation of the service."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the service characteristic."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the service characteristic."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the service characteristic which is editable from UI."
        },
        "configItemPath":{
            "type":"string",
            "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
        }
    }
}

Nested Schema : RelatedServiceOrderItem

Type: object

The service order item which triggered service creation/change/termination.

Show Source

• itemAction: string
  Allowed Values: [ "add", "modify", "delete", "noChange" ]

  Valid values for the lifecycle state of the orderItemAction.
• itemId: string
  Identifier of the order item where the service was managed.
• role: string
  Role of the service order item for this service.
• serviceOrderHref: string
  Reference of the related entity.
• serviceOrderId: string
  Unique identifier of a related entity.

{
    "type":"object",
    "required":[
        "itemId, serviceOrderId"
    ],
    "description":"The service order item which triggered service creation/change/termination.",
    "properties":{
        "itemAction":{
            "$ref":"#/components/schemas/OrderItemActionEnum"
        },
        "itemId":{
            "type":"string",
            "description":"Identifier of the order item where the service was managed."
        },
        "role":{
            "type":"string",
            "description":"Role of the service order item for this service."
        },
        "serviceOrderHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "serviceOrderId":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        }
    }
}

Nested Schema : ServiceRelationship

Type: object

Describes links with services of the same category (useful for bundled services).

Show Source

• relationshipType(required): string
  The type of relationship (e.g. depends on, enables)
• service(required): object schema
  Service Class.
• serviceRelationshipCharacteristic: array serviceRelationshipCharacteristic

{
    "required":[
        "relationshipType",
        "service"
    ],
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The type of relationship (e.g. depends on, enables)"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "serviceRelationshipCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            }
        }
    },
    "description":"Describes links with services of the same category (useful for bundled services)."
}

Nested Schema : serviceRelationshipCharacteristic

Type: array

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

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

Nested Schema : ResourceServiceRef

The resource reference on a service.

Match All

Show Source

• object ResourceRef
• object ResourceServiceRef-allOf[1]

{
    "description":"The resource reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceRef"
        },
        {
            "type":"object",
            "properties":{
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "expandResource":{
                    "$ref":"#/components/schemas/ResourceBase"
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the resource."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the resource."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the resource which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : ResourceRef

Type: object

Show Source

• @referredType: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• href: string
  Read Only: true

  Reference of the supporting resource.
• id: string
  Unique identifier of the supporting resource.
• name: string
  Name of the resource supporting the service.

{
    "type":"object",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the supporting resource."
        },
        "href":{
            "type":"string",
            "description":"Reference of the supporting resource.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the resource supporting the service."
        },
        "@referredType":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        }
    }
}

Nested Schema : ResourceServiceRef-allOf[1]

Type: object

Show Source

• assignmentState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• configItemDisplayName: string
  The config item display name of the resource which is editable from UI.
• configItemId: string
  The config item id of the resource.
• configItemName: string
  The config item name of the resource.
• consumerName: string
  The name of the service consumer.
• expandResource: object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• referenceState: string
  Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]

  The list of valid values for reference state.

{
    "type":"object",
    "properties":{
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "expandResource":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the resource."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the resource."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the resource which is editable from UI."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : externalIdentity

Type: object

Read Only: true

The external identity details for the federated resource.

Match All

Show Source

• object ExternalIdentity
  An external identity.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExternalIdentity"
        }
    ],
    "description":"The external identity details for the federated resource.",
    "readOnly":true
}

Nested Schema : place

Type: array

The list of associated geographic places.

Show Source

• Array of: object PlaceRef
  A place to associate with the resource/service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceRef"
    },
    "description":"The list of associated geographic places."
}

Nested Schema : resourceCharacteristic

Type: array

The list of characteristics for the resource.

Show Source

• Array of: object Characteristic
  A characteristic of an object or entity represented by a name-value pair.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the resource."
}

Nested Schema : resourceRelationship

Type: array

The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.

Show Source

• Array of: object ResourceRelationship
  A relationship to a resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRelationship"
    },
    "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
}

Nested Schema : ResourceRelationship

Type: object

A relationship to a resource.

Show Source

• fromRole: string
  The role name for the from-resource. Applies only to INVOLVE relationship types.
• relationshipType: string
  Allowed Values: [ "ASSOCIATES", "MAPPEDTO", "PARENT", "CHILD", "INVOLVE", "ASSIGN", "CONSUMER" ]

  The list of valid values for relationship type.
• resourceRef: object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• toRole: string
  The role name for the to-resource. Applies only to INVOLVE relationship types.

{
    "type":"object",
    "description":"A relationship to a resource.",
    "properties":{
        "relationshipType":{
            "$ref":"#/components/schemas/RelationshipTypeEnum"
        },
        "resourceRef":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "fromRole":{
            "type":"string",
            "description":"The role name for the from-resource. Applies only to INVOLVE relationship types."
        },
        "toRole":{
            "type":"string",
            "description":"The role name for the to-resource. Applies only to INVOLVE relationship types."
        }
    }
}

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

401 Response

You aren't authorized to make this request.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

403 Response

The request is forbidden.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

404 Response

The resources wasn't found.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

500 Response

An internal server error occurred.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

This example shows how to update the details of a service of a given ID by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X PATCH "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/ID" -H credentials @servicePatch.json

where:

• hostname is the URL for the UIM REST server.
• port is the port for the UIM REST server.
• version is the version of the API you're using.
• ID is the ID of the service to be updated.
• servicePatch.json is the JSON file with updated values.

Example of Request Body

This shows an example of the contents of the servicePatch.json file sent as the request body for the MERGE patch.

Note:

The MERGE patch requests should not have ID and Service-Specification attributes in the requests as they cannot be updated.

In ServiceCharacteristic, the serviceSpecName value is a mandatory input for service and ServiceConfiguration characteristics. The serviceSpecName parameter is used to distinguish to which service and serviceConfiguration do the characteristics belong. The configItemPath parameter is a mandatory input to denote ServiceConfigurationItem level properties or characteristics.

For place and relatedParty, the null value for configItemName indicates that place or relatedParty is for associating the service. For any other value, it can be an assignment or a reference on ServiceConfigItem.

{
   "name": "BroadbandCFSUpdated",
   "supportingResource": [
      {
         "id": "1-675003",
         "name": "DOCSIS LD",
         "@referredType": "LogicalDevice",
         "consumerName": "DOCSISRFS"
      },
      {
         "id": "1-675004",
         "name": "CPE_Management_System_1",
         "@referredType": "LogicalDevice",
         "consumerName": "DOCSISRFS"
      }
   ],
   "relatedParty": [
      {
         "id": "225004",
         "name": "Snow White",
         "role": "Customer",
         "referenceType": "Association",
         "consumerName": "BroadbandCFSUpdated"
      },
      {
         "id": "225005",
         "name": "Warehouse_1",
         "referenceType": "Reference",
         "consumerName": "DOCSISRFS"
      }
   ],
   "serviceCharacteristic": [
      {
         "name": "serviceRelType1",
         "valueType": "ALPHANUMERIC",
         "value": "relies-on",
         "serviceName": "BroadbandCFSUpdated",
         "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
      },
      {
         "name": "serviceRel1",
         "valueType": "ALPHANUMERIC",
         "value": "EmaiLCFS",
         "serviceName": "BroadbandCFSUpdated",
         "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
      },
      {
         "name": "Config_Profile_ID",
         "valueType": "ALPHANUMERIC",
         "value": "Motorola",
         "serviceName": "DOCSISRFS",
         "serviceSpecName": "DOCS_RFS"
      },
      {
         "name": "CPE_Enabled",
         "valueType": "BOOLEAN",
         "value": "true",
         "serviceName": "DOCSISRFS",
         "serviceSpecName": "DOCS_RFS"
      },
      {
         "name": "MaxUpstream",
         "valueType": "ALPHANUMERIC",
         "value": "30 Mbps",
         "serviceName": "DOCSISRFS",
         "serviceSpecName": "DOCS_RFS"
      },
      {
         "name": "MaxDownstream",
         "valueType": "ALPHANUMERIC",
         "value": "160 Mbps",
         "serviceName": "DOCSISRFS",
         "serviceSpecName": "DOCS_RFS"
      }
   ]
   "state": "designed"
}

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the service details for a given ID.

{
    "id": "825003",
    "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/v3/service/825003",
    "businessInteraction": {
        "id": "600001",
        "state": "IN_PROGRESS"
    },
    "category": "CFS",
    "hasStarted": false,
    "isServiceEnabled": false,
    "name": "BroadbandCFSUpdated",
    "serviceDate": "2022-05-12T10:44:09.090Z",
	"supportingResource": [
      {
         "id": "1-675003",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/1-675003",
         "name": "DOCSIS LD",
         "@referredType": "LogicalDevice",
         "consumerName": "DOCSISRFS",
         "assignmentState": "PENDING_ASSIGN"
      },
      {
         "id": "1-675004",
         "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/1-675004",
         "name": "CPE_Management_System_1",
         "@referredType": "LogicalDevice",
         "consumerName": "DOCSISRFS",
         "referenceState": "PENDING_REFERENCE"
      }
   ],
   "startDate": "2022-05-12T10:44:06.061Z",
   "relatedParty": [
      {
         "id": "225004",
         "href": "http://hostname:port/InventoryRSOpenAPI/party/225002",
         "name": "Snow White",
         "role": "Customer",
         "referenceType": "Association",
         "consumerName": "BroadbandCFS"
      },
      {
         "id": "225005",
         "href": "http://hostname:port/InventoryRSOpenAPI/party/225003",
         "name": "Warehouse_1",
         "referenceType": "Reference",
         "consumerName": "DOCSISRFS",
         "referenceState": "PENDING_REFERENCE"
      }
   ],
   "serviceCharacteristic": [
	  {
		 "name": "serviceRelType1",
		 "valueType": "ALPHANUMERIC",
		 "value": "relies-on",
		 "serviceName": "BroadbandCFSUpdated",
		 "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
	  },
	  {
		 "name": "serviceRel1",
		 "valueType": "ALPHANUMERIC",
		 "value": "EmaiLCFS",
		 "serviceName": "BroadbandCFS",
		 "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
	  },
	  {
		 "name": "Config_Profile_ID",
		 "valueType": "ALPHANUMERIC",
		 "value": "Motorola",
		 "serviceName": "DOCSISRFS",
              "serviceSpecName": "DOCS_RFS"
	  },
	  {
		 "name": "CPE_Enabled",
		 "valueType": "BOOLEAN",
		 "value": "true",
		 "serviceName": "DOCSISRFS",
              "serviceSpecName": "DOCS_RFS"
	  },
	  {
		 "name": "MaxUpstream",
		 "valueType": "ALPHANUMERIC",
		 "value": "30 Mbps",
		 "serviceName": "DOCSISRFS",
              "serviceSpecName": "DOCS_RFS"
	  },
	  {
		 "name": "MaxDownstream",
		 "valueType": "ALPHANUMERIC",
		 "value": "160 Mbps",
		 "serviceName": "DOCSISRFS",
              "serviceSpecName": "DOCS_RFS"
	  }
	],
	"serviceRelationship": [
      {
         "relationshipType": "relies-on",
         "service": {
            "id": "450005",
            "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/v3/service/450005"
         }
      }
   ],
    "serviceType": "Broadband Internet CFS Service",
    "supportingService": [
  {
	 "id": "450002",
	 "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/450002",
	 "name": "DOCSISRFS"
  }
],
"serviceSpecification": {
        "id": "Broadband_Internet_REST_Junit_CFS",
        "href": "http://hostname:port/InventoryRSOpenAPI/specification/Broadband_Internet_REST_Junit_CFS",
        "name": "Broadband_Internet_REST_Junit_CFS",
        "version": "1",
        "entityType": "Service",
        "startDate": "2022-04-07T00:00:01.000Z",
        "endDate": "2038-01-19T08:44:07.000Z"
    },
    "state": "designed",
	"place": [
      {
         "id": "525001",
         "href": "http://hostname:port/InventoryRSOpenAPI/place/525001",
         "name": "75024 Plano 54489 Trent St.",
         "referenceType": "Reference",
         "consumerName": "BroadbandCFS",
         "referenceState": "PENDING_REFERENCE"
      },
      {
         "id": "525002",
         "href": "http://hostname:port/InventoryRSOpenAPI/place/525002",
         "name": "75024 Plano TX USA 54489 Trent St.",
         "referenceType": "Reference",
         "consumerName": "DOCSISRFS",
         "referenceState": "PENDING_REFERENCE"
      }
   ],
   "effectiveDate": "2022-05-12T10:44:06.061Z"
}

Back to Top