{ "info": { "title": "Service Activation Confirm HLR Registration", "version": "4.0.0", "description": "Service Activation and Configuration API goal is to provide the ability to activate and configure Service. This API features Monitor pattern allowing to manage service configuration/activation asynchronous request (server side will provide monitor as POST/PATCH response). \n ### TMF640 performs the following Operations on service resource :\n - Retrieve a service or a collection of services depending on filter criteria\n - Partial update of an service\n - Create a service (including default values and creation rules)\n - Delete a service (for administration purposes)\n - Manage notification of events " }, "tags": [], "paths": { "/healthz": { "get": { "summary": "Health Check", "responses": { "200": { "content": { "application/json": { "example": "tmf640-serviceActivation-HLRRegistration" } }, "description": "Success" } }, "description": "Health Check", "x-page-slug": "/healthz" } }, "/service/{id}": { "get": { "summary": "Confirm HLR Registration", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_HLRRegistration" }, "example": { "id": "", "LTE": { "dataEnabledIndicator": false, "voiceEnabledIndicator": false }, "HSPA": { "dataEnabledIndicator": false, "voiceEnabledIndicator": false }, "hlrprofile": { "id": "", "mdn": "", "Gprs": { "netAccess": 0, "PDPContext": [ { "packetDataProtocolName": "", "ipAddress": "", "ipAddressType": "", "extendedIPAddress": "", "extendedIpType": "", "qosCOSName": "" } ] }, "Barring": { "incoming": "", "outgoing": "" }, "MSCDetails": { "e164Address": "", "e164Location": "", "mscStateChangeRecord": "", "prevServingMscAddress": "" }, "VLRDetails": { "e164Address": "", "e164Location": "", "currentVLRAttached": false, "prevServingVlrAddress": "" }, "SGSNDetails": { "e164Address": "", "e164Location": "", "currentSGSNAttached": false, "prevServingSgsnAddress": "" }, "roamEntitlement": "", "CallingFeatures": { "CallerId": [ { "ctype": "ID", "provisionedIndicator": false, "activeIndicator": false, "blockMode": 0, "overrideIndicator": false } ], "CallWaiting": { "activeIndicator": false, "provisionedIndicator": false }, "CallForwarding": [ { "ctype": "BUSY", "provisionedIndicator": false, "activeIndicator": false, "forwardingRingTime": "", "forwardingTN": "" } ], "SmsRestrictions": { "OriginatingRestriction": { "activeIndicator": false, "provisionedIndicator": false }, "TerminatingRestriction": { "activeIndicator": false, "provisionedIndicator": false } }, "MultiPartyCalling": { "activeIndicator": false, "provisionedIndicator": false } }, "dataRoamEntitlement": "", "camelClassOfServiceName": "" }, "imshssProfile": { "IPMutimediaDetails": { "PublicIdentity": [ { "id": "", "unregisteredServiceIndicator": false, "barringIndicator": false, "defaultIdIndicator": false } ], "privateIdentity": [ "" ], "PrivatePublicIdentity": [ { "id": [ "" ], "pairRegistrationStatus": [ "" ] } ] }, "UserServiceProfile": { "initialFilterCriteria": [ "" ], "globalServiceProfileId": "" }, "ImplicitRegistrationSet": { "scscfName": [ "" ], "impiRefStatus": [ "" ], "registrationStatus": [ "" ] } }, "epchssProfile": { "id": "", "mdn": "", "imei": "", "maxUploadSpeed": "", "maxDownloadSpeed": "", "sgsnAttachStatus": "", "roamingRestrictionsClass": "", "PacketDataProtocolDetails": { "defaultName": "", "operatorIdReplacement": "", "AccessPointConfigEntry": [ { "name": "", "serviceClass": "" } ] }, "mmeRegistrationAttachStatus": "", "MobilityManagementEntityDetails": { "attachStatus": "", "servingMMEName": "", "imsVoiceOverPSS": "", "attachedTimeStamp": "", "servingMMEDestRealm": "", "purgedInMMEIndicator": false, "previousServingMMEName": "" } } } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/trait_jwt_400" }, "401": { "$ref": "#/components/responses/trait_jwt_401" }, "403": { "$ref": "#/components/responses/trait_error-responses_403" }, "404": { "$ref": "#/components/responses/trait_error-responses_404" }, "405": { "$ref": "#/components/responses/trait_error-responses_405" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "$ref": "#/components/responses/trait_error-responses_500" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "@type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "HLRRegistration" ] }, "description": "Type of the Service" }, { "name": "billingMarket", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Billing market" }, { "name": "billingSubMarket", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Billing submarket" }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated properties to provide in response" }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-ClientId" } ], "x-page-slug": "confirm-hlr-reg", "description": "This operation retrieves a Service entity to confirm HLR Registration. Attribute selection is enabled for all first level attributes. (TMF 640)", "operationId": "confirmhlr" }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "pattern": "\\d{10}$" }, "description": "Identifier of the Service" } ] } }, "openapi": "3.0.3", "components": { "links": {}, "schemas": { "lib_Any": {}, "lib_Note": { "type": "object", "required": [ "id?", "author?", "date?", "text?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)" }, "date?": { "type": "string", "format": "date-time", "description": "Date of the note" }, "text?": { "type": "string", "description": "Text of the note" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "author?": { "type": "string", "description": "Author of the note" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_array": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "description" ], "properties": { "id": { "type": "string", "description": "Unique identifier for each item in the array" }, "name": { "type": "string", "description": "Name of the item" }, "@type?": { "type": "string", "description": "Defines the sub-class extensible name when sub-classing" }, "@baseType?": { "type": "string", "description": "Defines the super-class when sub-classing" }, "description": { "type": "string", "description": "Description of the item" }, "@schemaLocation?": { "type": "string", "description": "URI to a JSON-Schema file that defines additional attributes and relationships" } } } }, "lib_Error": { "type": "object", "required": [ "code", "reason", "message?", "status?", "referenceError?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "status?": { "type": "string", "description": "HTTP Error code extension" }, "message?": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "referenceError?": { "type": "string", "description": "URI of documentation describing the error." }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Place": { "type": "object", "required": [ "id?", "href?", "name?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the place" }, "href?": { "type": "string", "description": "Unique reference of the place" }, "name?": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_object": { "type": "object", "required": [ "id", "name", "description", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the object" }, "name": { "type": "string", "description": "Name of the object" }, "@type?": { "type": "string", "description": "Defines the sub-class extensible name when sub-classing" }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the object was created" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp when the object was last updated" }, "@baseType?": { "type": "string", "description": "Defines the super-class when sub-classing" }, "description": { "type": "string", "description": "Description of the object" }, "@schemaLocation?": { "type": "string", "description": "URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Request": { "type": "object", "required": [ "body", "method?", "to?", "header", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "to?": { "type": "string", "description": "The target of the request, e.g. a URL for an HTTP request" }, "body": { "type": "string", "description": "The body of the request. For example for an HTTP request might contain content of a form ." }, "header": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication." } ] }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "method?": { "type": "string", "description": "The protocol of the request, e.g. http" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Monitor": { "type": "object", "required": [ "id?", "href?", "sourceHref?", "state?", "request?", "response?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Identifier of an instance of the monitor. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type" }, "href?": { "type": "string", "description": "reference to this monitor" }, "state?": { "type": "string", "description": "The Monitor state of the resource. InProgress, InError, Completed" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "request?": {}, "response?": {}, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "sourceHref?": { "type": "string", "description": "The monitored resource href" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Service": { "type": "object", "required": [ "id?", "href?", "category?", "description?", "endDate?", "hasStarted?", "isBundle?", "isServiceEnabled?", "isStateful?", "name?", "serviceDate?", "serviceType?", "startDate?", "startMode?", "feature?", "note?", "place?", "relatedEntity?", "relatedParty?", "serviceCharacteristic?", "serviceOrderItem?", "serviceRelationship?", "serviceSpecification?", "state?", "supportingResource?", "supportingService?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the service" }, "href?": { "type": "string", "description": "Reference of the service" }, "name?": { "type": "string", "description": "Name of the service" }, "note?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of notes made on this service" } ] }, "place?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)" } ] }, "state?": {}, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate?": { "type": "string", "format": "date-time", "description": "Date when the service ends" }, "feature?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of feature associated with this service " } ] }, "category?": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle?": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate?": { "type": "string", "format": "date-time", "description": "Date when the service starts" }, "startMode?": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted?": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful?": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description?": { "type": "string", "description": "Free-text description of the service" }, "serviceDate?": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType?": { "type": "string", "description": "Business type of the service" }, "relatedParty?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity" } ] }, "relatedEntity?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related entity in relationship with this service " } ] }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled?": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "serviceOrderItem?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of service order items related to this service" } ] }, "supportingService?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)" } ] }, "supportingResource?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources" } ] }, "serviceRelationship?": { "allOf": [ { "$ref": "#/components/schemas/lib_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)." } ] }, "serviceSpecification?": {}, "serviceCharacteristic?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) " } ] } } }, "lib_Feature": { "type": "object", "required": [ "id?", "isBundle?", "isEnabled?", "name", "constraint?", "featureCharacteristic", "featureRelationship?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the feature." }, "name": { "type": "string", "description": "This is the name for the feature." }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "isBundle?": { "type": "boolean", "description": "True if this is a feature group. Default is false." }, "isEnabled?": { "type": "boolean", "description": "True if this feature is enabled. Default is true." }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "constraint?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "This is a list of feature constraints." } ] }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "featureRelationship?": { "$ref": "#/components/schemas/lib_array" }, "featureCharacteristic": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "This is a list of Characteristics for a particular feature." } ] } } }, "lib_PlaceRef": { "type": "object", "required": [ "id", "href?", "name?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href?": { "type": "string", "description": "Hyperlink reference" }, "name?": { "type": "string", "description": "Name of the related entity." }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Response": { "type": "object", "required": [ "body", "statusCode?", "header", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "body": { "type": "string", "description": "The body of the response. For example for an HTTP response might contain HTML for rendering." }, "header": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "Items included in the header of the response. For example for an HTTP response might contain negotiated locale." } ] }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "statusCode?": { "type": "string", "description": "The status of the response. For example for an HTTP response would be codes such as 200, 400, etc." }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_EntityRef": { "type": "object", "required": [ "id", "href?", "name?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href?": { "type": "string", "description": "Hyperlink reference" }, "name?": { "type": "string", "description": "Name of the related entity." }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_HeaderItem": { "type": "object", "required": [ "name", "value", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "name": { "type": "string", "description": "The name of the header item, e.g. locale" }, "value": { "type": "string", "description": "The value of the header item, e.g. en-us" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_Extensible": { "type": "object", "required": [ "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ServiceRef": { "type": "object", "required": [ "id", "href?", "name?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href?": { "type": "string", "description": "Hyperlink reference" }, "name?": { "type": "string", "description": "Name of the related entity." }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_HLRProfile": { "type": "object", "required": [ "id", "mdn?", "Gprs?", "MSCDetails?", "VLRDetails?", "SGSNDetails?", "camelClassOfServiceName?", "roamEntitlement?", "dataRoamEntitlement?", "CallingFeatures?", "Barring?" ], "properties": { "id": { "type": "string", "maxLength": 15, "description": "the 15-digit unique mobile station ID" }, "mdn?": { "type": "string", "maxLength": 11, "description": "the 10-digit dialable number, sometime is 11 digit with 1 digit as prefix" }, "Gprs?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "General Packet Radio Service" } ] }, "Barring?": { "$ref": "#/components/schemas/lib_object" }, "MSCDetails?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "Mobile Switching Center Type" } ] }, "VLRDetails?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "Visiting (or Visitor) Location Register Type" } ] }, "SGSNDetails?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "Serving GPRS Support Node Type" } ] }, "roamEntitlement?": { "type": "string", "maxLength": 80, "description": "Roaming Profile – Voice. This implements a mechanism to limit GPRS/UMTS voice services while roaming off the network, without impacting the Subscriber’s data services. Examples : CRICKET_HPLMN/ ZED_All US, Intl Value / ZED_US Prem, Intl Premium / NATL_NOPETROCOM /Restrict to PR and USVI only / Machine_to_Machine_USPRM_INTLPRM / etc" }, "CallingFeatures?": { "$ref": "#/components/schemas/lib_object" }, "dataRoamEntitlement?": { "type": "string", "maxLength": 80, "description": "Roaming Profile – Data This implements a mechanism to limit GPRS/UMTS data services (MMS and Internet access) while roaming off the network, without impacting the Subscriber’s data services. Exapmples : DREP_ZED_NA US,Can, Mex,Carib / DREP_ZED_All US No Intl / BLUE NATL / DREP_ZED_Custom_Amazon Only / DREP_Machine_to_Machine_USPRM_INTLPRM /" }, "camelClassOfServiceName?": { "type": "string", "maxLength": 100, "description": "Displays the technical name of the CAMEL service that is provisioned on the HLR. Hotlining." } } }, "lib_Addressable": { "type": "object", "required": [ "id?", "href?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "unique identifier" }, "href?": { "type": "string", "description": "Hyperlink reference" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_EntityValue": { "type": "object", "required": [ "id?", "href?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of a related entity." }, "href?": { "type": "string", "description": "Reference of the related entity." }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ResourceRef": { "type": "object", "required": [ "id", "href?", "name?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href?": { "type": "string", "description": "Hyperlink reference" }, "name?": { "type": "string", "description": "Name of the related entity." }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_RelatedParty": { "type": "object", "required": [ "id", "href?", "name?", "role?", "@baseType?", "@schemaLocation?", "@type?", "@referredType" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href?": { "type": "string", "description": "Hyperlink reference" }, "name?": { "type": "string", "description": "Name of the related entity." }, "role?": { "type": "string", "description": "Role played by the related party" }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_EPCHSSProfile": { "type": "object", "required": [ "id?", "mdn?", "imei?", "MobilityManagementEntityDetails?", "PacketDataProtocolDetails?", "roamingRestrictionsClass?", "mmeRegistrationAttachStatus?", "maxUploadSpeed?", "maxDownloadSpeed?", "sgsnAttachStatus?" ], "properties": { "id?": { "type": "string", "maxLength": 15, "description": "the 15-digit unique mobile station ID" }, "mdn?": { "type": "string", "maxLength": 11, "description": "the 10-digit dialable number, sometime is 11 digit with 1 digit as prefix" }, "imei?": { "type": "string", "maxLength": 17, "description": "International Mobile Equipment Identification, a unique number assigned to each device" }, "maxUploadSpeed?": { "type": "string", "maxLength": 50, "description": "ambrMaxReqBandwidthUl Upload speed, overall subscriber maximum (bits/second) values." }, "maxDownloadSpeed?": { "type": "string", "maxLength": 50, "description": "ambrMaxReqBandwidthDl. Dowonload speed, overall subscriber maximum (bits/second) values." }, "sgsnAttachStatus?": { "type": "string", "maxLength": 30, "description": "Serving GPRS Support Node attach status. Indicates the purged status of the Subscriber’s 4G LTE radio registration in SGSN. Possible values are: Never Attached (0). Currently Not Attached (1) Currently Attached in HPLMN (Home Zone) (2) Currently Attached in VPLMN (Roaming) (3) The value in the last parenthesis will be returned. In this case for example: the values would be 0, 1, 2, and 3." }, "roamingRestrictionsClass?": { "type": "string", "maxLength": 100, "description": "This value defines the Subscriber's overall roaming performance. For LTE Phase 1, ATT plans to roll out all subscribers in the \"Home PLMN\" roaming class." }, "PacketDataProtocolDetails?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "Packet Data Protocol" } ] }, "mmeRegistrationAttachStatus?": { "type": "string", "maxLength": 50, "description": "attachStatus. MME Registration/Attach Status. Indicates whether or not the Subscriber’s 4G LTE radio registration has been purged successfully in the MME. Possible values: Never Attached (0) Currently Not Attached (1) Currently Attached in HPLMN (Home Zone) (2) Currently Attached in VPLMN (Roaming) (3)" }, "MobilityManagementEntityDetails?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "Mobility Management Entity" } ] } } }, "lib_ConstraintRef": { "type": "object", "required": [ "id", "href?", "name?", "version?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id": { "type": "string", "description": "reference id to the target constraint" }, "href?": { "type": "string", "description": "Hyperlink reference to the target constraint" }, "name?": { "type": "string", "description": "Name given to the constraint" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "version?": { "type": "string", "description": "constraint version" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "description": "The (class) type of the referred constraint" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_IMSHSSProfile": { "type": "object", "required": [ "ImplicitRegistrationSet?", "IPMutimediaDetails?", "UserServiceProfile?" ], "properties": { "IPMutimediaDetails?": { "$ref": "#/components/schemas/lib_object" }, "UserServiceProfile?": { "$ref": "#/components/schemas/lib_object" }, "ImplicitRegistrationSet?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "Implicit Registration Set" } ] } } }, "lib_Service_Create": { "type": "object", "required": [ "category?", "description?", "endDate?", "hasStarted?", "isBundle?", "isServiceEnabled?", "isStateful?", "name?", "serviceDate?", "serviceType?", "startDate?", "startMode?", "feature?", "note?", "place?", "relatedEntity?", "relatedParty?", "serviceCharacteristic?", "serviceOrderItem?", "serviceRelationship?", "serviceSpecification", "state", "supportingResource?", "supportingService?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "name?": { "type": "string", "description": "Name of the service" }, "note?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of notes made on this service" } ] }, "state": {}, "place?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)" } ] }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate?": { "type": "string", "format": "date-time", "description": "Date when the service ends" }, "feature?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of feature associated with this service " } ] }, "category?": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle?": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate?": { "type": "string", "format": "date-time", "description": "Date when the service starts" }, "startMode?": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted?": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful?": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description?": { "type": "string", "description": "Free-text description of the service" }, "serviceDate?": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType?": { "type": "string", "description": "Business type of the service" }, "relatedParty?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity" } ] }, "relatedEntity?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related entity in relationship with this service " } ] }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled?": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "serviceOrderItem?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of service order items related to this service" } ] }, "supportingService?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)" } ] }, "supportingResource?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources" } ] }, "serviceRelationship?": { "allOf": [ { "$ref": "#/components/schemas/lib_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)." } ] }, "serviceSpecification": {}, "serviceCharacteristic?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) " } ] } } }, "lib_Service_Update": { "type": "object", "required": [ "category?", "description?", "endDate?", "hasStarted?", "isBundle?", "isServiceEnabled?", "isStateful?", "name?", "serviceType?", "startDate?", "startMode?", "feature?", "note?", "place?", "relatedEntity?", "relatedParty?", "serviceCharacteristic?", "serviceOrderItem?", "serviceRelationship?", "serviceSpecification?", "state?", "supportingResource?", "supportingService?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "name?": { "type": "string", "description": "Name of the service" }, "note?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of notes made on this service" } ] }, "place?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)" } ] }, "state?": {}, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "endDate?": { "type": "string", "format": "date-time", "description": "Date when the service ends" }, "feature?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of feature associated with this service " } ] }, "category?": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle?": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate?": { "type": "string", "format": "date-time", "description": "Date when the service starts" }, "startMode?": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "hasStarted?": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful?": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description?": { "type": "string", "description": "Free-text description of the service" }, "serviceType?": { "type": "string", "description": "Business type of the service" }, "relatedParty?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity" } ] }, "relatedEntity?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related entity in relationship with this service " } ] }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled?": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "serviceOrderItem?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of service order items related to this service" } ] }, "supportingService?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)" } ] }, "supportingResource?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources" } ] }, "serviceRelationship?": { "allOf": [ { "$ref": "#/components/schemas/lib_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)." } ] }, "serviceSpecification?": {}, "serviceCharacteristic?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) " } ] } } }, "lib_Characteristic": { "type": "object", "required": [ "id?", "name", "valueType?", "characteristicRelationship?", "value", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "value": {}, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "valueType?": { "type": "string", "description": "Data type of the value of the characteristic" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "characteristicRelationship?": { "$ref": "#/components/schemas/lib_array" } } }, "lib_HLRRegistration": { "type": "object", "required": [ "id" ], "properties": { "id": {}, "LTE": { "description": "4G. Not returned for WLL client" }, "HSPA": { "description": "2G and 3G. Not returned for WLL client" }, "hlrprofile?": {}, "QueryStatus?": { "allOf": [ { "$ref": "#/components/schemas/lib_object" }, { "description": "status returned from Torch systems via WLL flow." } ] }, "imshssProfile?": {}, "epchssProfile?": {} } }, "lib_ServiceStateType": { "type": "string", "enum": [ "feasibilityChecked", "designed", "reserved", "inactive", "active", "terminated" ], "description": "Valid values for the lifecycle state of the service" }, "lib_ServiceRefOrValue": { "type": "object", "required": [ "id?", "href?", "category?", "description?", "endDate?", "hasStarted?", "isBundle?", "isServiceEnabled?", "isStateful?", "name?", "serviceDate?", "serviceType?", "startDate?", "startMode?", "feature?", "note?", "place?", "relatedEntity?", "relatedParty?", "serviceCharacteristic?", "serviceOrderItem?", "serviceRelationship?", "serviceSpecification?", "state?", "supportingResource?", "supportingService?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the service" }, "href?": { "type": "string", "description": "Reference of the service" }, "name?": { "type": "string", "description": "Name of the service" }, "note?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of notes made on this service" } ] }, "place?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)" } ] }, "state?": {}, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "endDate?": { "type": "string", "format": "date-time", "description": "Date when the service ends" }, "feature?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of feature associated with this service " } ] }, "category?": { "type": "string", "description": "Is it a customer facing or resource facing service" }, "isBundle?": { "type": "boolean", "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)." }, "startDate?": { "type": "string", "format": "date-time", "description": "Date when the service starts" }, "startMode?": { "type": "string", "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "hasStarted?": { "type": "boolean", "description": "If TRUE, this Service has already been started" }, "isStateful?": { "type": "boolean", "description": "If TRUE, this Service can be changed without affecting any other services" }, "description?": { "type": "string", "description": "Free-text description of the service" }, "serviceDate?": { "type": "string", "description": "Date when the service was created (whatever its status)." }, "serviceType?": { "type": "string", "description": "Business type of the service" }, "relatedParty?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity" } ] }, "relatedEntity?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of related entity in relationship with this service " } ] }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "isServiceEnabled?": { "type": "boolean", "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed " }, "serviceOrderItem?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of service order items related to this service" } ] }, "supportingService?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)" } ] }, "supportingResource?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources" } ] }, "serviceRelationship?": { "allOf": [ { "$ref": "#/components/schemas/lib_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)." } ] }, "serviceSpecification?": {}, "serviceCharacteristic?": { "allOf": [ { "$ref": "#/components/schemas/lib_array" }, { "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*]) " } ] } } }, "lib_EventSubscription": { "type": "object", "required": [ "id", "callback", "query?" ], "properties": { "id": { "type": "string", "description": "Id of the listener" }, "query?": { "type": "string", "description": "additional data to be passed" }, "callback": { "type": "string", "description": "The callback being registered." } } }, "lib_MonitorCreateEvent": { "type": "object", "required": [ "event?", "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?" ], "properties": { "event?": {}, "title?": { "type": "string", "description": "The title of the event." }, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_ServiceCreateEvent": { "type": "object", "required": [ "event?", "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?" ], "properties": { "event?": {}, "title?": { "type": "string", "description": "The title of the event." }, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_ServiceDeleteEvent": { "type": "object", "required": [ "event?", "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?" ], "properties": { "event?": {}, "title?": { "type": "string", "description": "The title of the event." }, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_MonitorDeleteEvent": { "type": "object", "required": [ "event?", "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?" ], "properties": { "event?": {}, "title?": { "type": "string", "description": "The title of the event." }, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_HLRRegistrationInfo": { "type": "object", "required": [ "voiceEnabledIndicator?", "dataEnabledIndicator?" ], "properties": { "dataEnabledIndicator?": { "type": "boolean" }, "voiceEnabledIndicator?": { "type": "boolean" } } }, "lib_ServiceRelationship": { "type": "object", "required": [ "relationshipType", "ServiceRelationshipCharacteristic?", "service?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "service?": {}, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "relationshipType": { "type": "string" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "ServiceRelationshipCharacteristic?": { "$ref": "#/components/schemas/lib_array" } } }, "lib_FeatureRelationship": { "type": "object", "required": [ "id?", "name", "relationshipType", "validFor?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the target feature." }, "name": { "type": "string", "description": "This is the name of the target feature." }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "validFor?": {}, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "relationshipType": { "type": "string", "description": "This is the type of the feature relationship." }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_OrderItemActionType": { "type": "string", "enum": [ "add", "modify", "delete", "noChange" ], "description": "action to be performed on the product" }, "lib_EventSubscriptionInput": { "type": "object", "required": [ "callback", "query?" ], "properties": { "query?": { "type": "string", "description": "additional data to be passed" }, "callback": { "type": "string", "description": "The callback being registered." } } }, "lib_RelatedPlaceRefOrValue": { "type": "object", "required": [ "id?", "href?", "name?", "role", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the place" }, "role": { "type": "string" }, "href?": { "type": "string", "description": "Unique reference of the place" }, "name?": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_ServiceSpecificationRef": { "type": "object", "required": [ "id", "href?", "name?", "version?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href?": { "type": "string", "description": "Hyperlink reference" }, "name?": { "type": "string", "description": "Name of the related entity." }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "version?": { "type": "string", "description": "Service specification version" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "default": "AttHLRRegistrationServiceSpecification", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " " } } }, "lib_MonitorStateChangeEvent": { "type": "object", "required": [ "event?", "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?" ], "properties": { "event?": {}, "title?": { "type": "string", "description": "The title of the event." }, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_ServiceStateChangeEvent": { "type": "object", "required": [ "event?", "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?" ], "properties": { "event?": {}, "title?": { "type": "string", "description": "The title of the event." }, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_RelatedEntityRefOrValue": { "type": "object", "required": [ "id?", "href?", "name?", "role", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of a related entity." }, "role": { "type": "string" }, "href?": { "type": "string", "description": "Reference of the related entity." }, "name?": { "type": "string", "description": "Name of the related entity." }, "@type?": { "type": "string", "example": "LogicalResourceSpecification", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@baseType?": { "type": "string", "example": "ResourceSpecification", "description": "When sub-classing, this defines the super-class" }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "example": " ", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } } }, "lib_RelatedServiceOrderItem": { "type": "object", "required": [ "itemId", "role?", "serviceOrderHref?", "serviceOrderId", "itemAction?", "@baseType?", "@schemaLocation?", "@type?", "@referredType?" ], "properties": { "role?": { "type": "string", "description": "role of the service order item for this service" }, "itemId": { "type": "string", "description": "Identifier of the order item where the service was managed" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "itemAction?": {}, "serviceOrderId": { "type": "string", "description": "Unique identifier of a related entity." }, "@referredType?": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "serviceOrderHref?": { "type": "string", "description": "Reference of the related entity." } } }, "lib_MonitorCreateEventPayload": { "type": "object", "required": [ "monitor?" ], "properties": { "monitor?": {} } }, "lib_ServiceDeleteEventPayload": { "type": "object", "required": [ "service?" ], "properties": { "service?": {} } }, "lib_ServiceCreateEventPayload": { "type": "object", "required": [ "service?" ], "properties": { "service?": {} } }, "lib_MonitorDeleteEventPayload": { "type": "object", "required": [ "monitor?" ], "properties": { "monitor?": {} } }, "lib_CharacteristicRelationship": { "type": "object", "required": [ "id?", "relationshipType?", "@baseType?", "@schemaLocation?", "@type?" ], "properties": { "id?": { "type": "string", "description": "Unique identifier of the characteristic" }, "@type?": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "@baseType?": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation?": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "relationshipType?": { "type": "string", "description": "The type of relationship" } } }, "lib_ServiceStateChangeEventPayload": { "type": "object", "required": [ "service?" ], "properties": { "service?": {} } }, "lib_FiberServiceGeneralMessageInfo": { "type": "object", "required": [ "messageCode?", "messageText?" ], "properties": { "messageCode?": { "type": "string" }, "messageText?": { "type": "string" } } }, "lib_MonitorStateChangeEventPayload": { "type": "object", "required": [ "monitor?" ], "properties": { "monitor?": {} } }, "lib_ServiceAttributeValueChangeEvent": { "type": "object", "required": [ "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?", "fieldPath?", "event?" ], "properties": { "title?": { "type": "string", "description": "The title of the event." }, "event?": {}, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "fieldPath?": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_MonitorAttributeValueChangeEvent": { "type": "object", "required": [ "eventId?", "eventTime?", "eventType?", "correlationId?", "domain?", "title?", "description?", "priority?", "timeOcurred?", "fieldPath?", "event?" ], "properties": { "title?": { "type": "string", "description": "The title of the event." }, "event?": {}, "domain?": { "type": "string", "description": "The domain of the event." }, "eventId?": { "type": "string", "description": "The identifier of the notification." }, "priority?": { "type": "string", "description": "A priority." }, "eventTime?": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType?": { "type": "string", "description": "The type of the notification." }, "fieldPath?": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "description?": { "type": "string", "description": "An explnatory of the event." }, "timeOcurred?": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "correlationId?": { "type": "string", "description": "The correlation id for this event." } } }, "lib_MonitorAttributeValueChangeEventPayload": { "type": "object", "required": [ "monitor?" ], "properties": { "monitor?": {} } }, "lib_ServiceAttributeValueChangeEventPayload": { "type": "object", "required": [ "service?" ], "properties": { "service?": {} } } }, "headers": {}, "examples": {}, "responses": { "trait_jwt_400": { "content": { "application/json": { "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF622", "message": "JWT Token is required" } } }, "description": "JWT Token is required." }, "trait_jwt_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF622", "message": "Invalid token" } } }, "description": "Invalid token." }, "trait_jwt_503": { "content": { "application/json": { "example": { "code": "503", "reason": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF622", "message": "Internal Server Error" } } }, "description": "Error communicating with JWKS server." }, "trait_error-responses_400": { "content": { "application/json": { "example": { "code": "400", "reason": "Bad Request", "status": "400", "message": "Required Key not Found", "referenceError": "" } } }, "description": "Bad Request." }, "trait_error-responses_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Unauthorized", "status": "401", "message": "Not Authorized", "referenceError": "" } } }, "description": "The supplied credentials are not valid." }, "trait_error-responses_403": { "content": { "application/json": { "example": { "code": "403", "reason": "Forbidden", "status": "403", "message": "Forbidden", "referenceError": "" } } }, "description": "There is a problem with the credentials that were provided." }, "trait_error-responses_404": { "content": { "application/json": { "example": { "code": "404", "reason": "Resource Not Found", "status": "404", "message": "Resource Not Found", "referenceError": "" } } }, "description": "The server cannot find the requested resource." }, "trait_error-responses_405": { "content": { "application/json": { "example": { "code": "405", "reason": "Method Not Allowed", "status": "405", "message": "Method not allowed / implemented", "@baseType": "", "referenceError": "" } } }, "description": "A request was made of a resource using a request method not supported by that resource;for example(using GET on a form which requires data to be presented via POST(or) using PUT on a read only resource)." }, "trait_error-responses_406": { "content": { "application/json": { "example": { "code": "406", "reason": "Not Acceptable", "status": "406", "message": "Not Acceptable", "referenceError": "" } } }, "description": "The target resource does not have a current representation that would be acceptable to the user agent." }, "trait_error-responses_415": { "content": { "application/json": { "example": { "code": "415", "reason": "Unsupported Media Type", "status": "415", "message": "Unsupported Media Type", "referenceError": "" } } }, "description": "The Content-Type specified in the header was unsupported media type." }, "trait_error-responses_500": { "content": { "application/json": { "example": { "code": "500", "reason": "Internal Server Error", "status": "500", "message": "Internal Server Error", "referenceError": "" } } }, "description": "An internal processing error occured while processing the API Request." }, "securityScheme_ATT_Azure_AD_JWT_Token_200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token_type", "expires_in", "ext_expires_in", "access_token" ], "properties": { "token_type": { "type": "string", "example": "Bearer", "default": "Bearer" }, "expires_in": { "type": "integer", "format": "int32", "example": 3599 }, "access_token": { "type": "string", "example": " " }, "ext_expires_in": { "type": "integer", "format": "int32", "example": 3599 } } } } }, "description": "No description provided" }, "securityScheme_ATT_Azure_AD_JWT_Token_400": { "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "error_description", "error_codes", "timestamp", "trace_id", "correlation_id", "error_uri" ], "properties": { "error": { "type": "string", "example": "unauthorized_client" }, "trace_id": { "type": "string", "example": " " }, "timestamp": { "type": "string", "example": "2021-06-30 21:12:34Z" }, "error_uri": { "type": "string", "example": "https://login.microsoftonline.com/error?code=700016" }, "error_codes": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 700016 } }, "correlation_id": { "type": "string", "example": " " }, "error_description": { "type": "string", "example": "AADSTS700016: Application with identifier '6bb2748d-d916-4534-9145-ee8f598d2e01' was not found in the directory 'e741d71c-c6b6-47b0-803c-0f3b32b07556'. This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant. You may have sent your authentication request to the wrong tenant.\\r\\" } } } } }, "description": "No description provided" } }, "callbacks": {}, "parameters": { "trait_headers_Accept": { "in": "header", "name": "Accept", "schema": { "type": "string", "default": "application/json" }, "required": true, "description": "Specifies the media type as \"application/json\"." }, "trait_jwt_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "JWT Bearer Token. Token URL: token \r\n\r\n See example below.\r\n\r\n curl --location --request POST ' Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on" }, "trait_headers_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "required": true, "description": "Valid JSON Web Token." }, "trait_headers_X-ATT-ClientId": { "in": "header", "name": "X-ATT-ClientId", "schema": { "type": "string" }, "required": false, "description": "A GUID1 derived from the JSON Web Token which represents the ClientId of the API Consumer who initiated the call flow at the Mule Gateway. This is used by downstream APIs to log data about the entity which initiated the call flow." }, "trait_headers_X-ATT-CorrelationId": { "in": "header", "name": "X-ATT-CorrelationId", "schema": { "type": "string" }, "required": false, "description": "A GUID1 provided by the client that typically serves as a reference ID used to correlate client activity with transactions processed by the server. It is generally paired with the X-ATT-ConversationId to help with tracing and observability." }, "securityScheme_ATT_Azure_AD_JWT_Token_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "example": "Bearer ", "required": true, "description": "JWT Bearer Token" } }, "requestBodies": {}, "securitySchemes": { "ATT_Azure_AD_JWT_Token": { "type": "oauth2", "flows": { "authorizationCode": { "scopes": {}, "tokenUrl": "", "authorizationUrl": "" } }, "description": "Get a JWT Token from AT&T's Azure AD" } } } }