{ "info": { "title": "ATT TMF702 Resource Activation Voicemailbox API ", "version": "4.0.0", "description": "## TMF API Reference: TMF702 - Resource Activation \n\n### Based on TMForum Release : 19.5 - December 2019\n\nResource Activation API goal is to provide the ability to activate Resources.\n\n### Operations\nResource Activation and Configuration API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity (for administration purposes)\n- Manage notification of events" }, "paths": { "/healthz": { "get": { "summary": "Health Check", "security": [], "responses": { "200": { "content": { "application/json": { "example": "Application up and running" } }, "description": "Success" } }, "x-page-slug": "702-get-health", "description": "Health Check" } }, "/resource/{id}": { "patch": { "tags": [ "resource" ], "summary": "Reset voicemail password", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Voicemailbox" }, "example": { "id": "string", "href": "string", "vmid": "43276584", "name": "resourceName", "note": [], "code": "0", "@type": "Voicemailbox", "place": { "id": "xxxx", "href": "http.xxxx", "name": "Paris Store", "role": "home delivery", "@type": "Voicemailbox", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "newPin": "xxxx", "category": "Gold", "@baseType": "", "attachment": [], "usageState": "idle", "description": "Success", "relatedParty": [], "referenceError": "", "resourceStatus": "standby", "resourceVersion": "1.0", "@schemaLocation": "http.xxxx", "endOperatingDate": "2024-08-14T19:08:09Z", "operationalState": "enable", "activationFeature": [], "startOperatingDate": "2024-08-14T19:01:09Z", "administrativeState": "locked", "resourceRelationship": [], "subscriberNumberType": "DIALABLE", "resourceSpecification": { "id": "xxxx", "href": "http.xxxx", "name": "xxxx", "@type": "Voicemailbox", "version": "1.0", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "resourceCharacteristic": [], "wirelessLocalLoopIndicator": false } } }, "description": "Updated" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "400", "@type": "Voicemailbox", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF702", "message": "JWT Token is required", "@baseType": "", "referenceError": "", "@schemaLocation": "http.xxxx" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "401", "@type": "Voicemailbox", "reason": "Invalid token", "status": "401-UNAUTHORIZED-TMF702", "message": "Invalid token", "@baseType": "", "referenceError": "", "@schemaLocation": "http.xxxx" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "403", "@type": "Voicemailbox", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF702", "message": "Forbidden", "@baseType": "", "referenceError": "", "@schemaLocation": "http.xxxx" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "404", "@type": "Voicemailbox", "reason": "Requested resource no found.", "status": "404-NOT_FOUND-TMF702", "message": "Requested resource no found.", "@baseType": "", "referenceError": "", "@schemaLocation": "http.xxxx" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "405", "@type": "Voicemailbox", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF702", "message": "HTTP Method get not allowed", "@baseType": "", "referenceError": "", "@schemaLocation": "http.xxxx" } } }, "description": "Method Not allowed" }, "406": { "$ref": "#/components/responses/trait_error-responses_406" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" } } }, "description": "Conflict" }, "415": { "$ref": "#/components/responses/trait_error-responses_415" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Error" }, "example": { "code": "500", "@type": "Voicemailbox", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF702", "message": "Internal Server Error", "@baseType": { "type": "string", "@type": "string", "description": "When sub-classing, this defines the super-class" }, "referenceError": "", "@schemaLocation": "http.xxxx" } } }, "description": "Internal Server Error" }, "503": { "$ref": "#/components/responses/trait_jwt_503" } }, "parameters": [ { "name": "@type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Voicemailbox" ], "default": "Voicemailbox" }, "description": "\\@type qualifies the resource. It should be set to Voicemailbox for all voicemailbox operations." }, { "$ref": "#/components/parameters/trait_jwt_Authorization" }, { "$ref": "#/components/parameters/trait_headers_Accept" }, { "$ref": "#/components/parameters/trait_headers_X-ATT-CorrelationId" } ], "x-page-slug": "reset-voice-mail-pw", "description": "This operation partially updates a Voicemailbox Resource entity by resetting the associated PIN. (TMF 702)", "operationId": "ResetVoicemailboxPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lib_Voicemailbox_Update" }, "example": { "name": "Paris Store", "vmid": "43276584", "note": [], "place": { "id": "xxxx", "href": "http.xxxx", "name": "Paris Store", "role": "home delivery", "@type": "Voicemailbox", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "@type": "Voicemailbox", "newPin": "1234", "category": "Gold", "@baseType": "", "attachment": [], "usageState": "idle", "description": "", "relatedParty": [], "resourceStatus": "standby", "@schemaLocation": "http.xxxx", "resourceVersion": "1.0", "operationalState": "enable", "endOperatingDate": "2024-08-14T19:08:09Z", "activationFeature": [], "startOperatingDate": "2024-08-14T19:01:09Z", "administrativeState": "unlocked", "resourceRelationship": [], "subscriberNumberType": "DIALABLE", "resourceSpecification": { "id": "xxxx", "href": "http.xxxx", "name": "xxxx", "@type": "Voicemailbox", "version": "1.0", "@baseType": "", "@referredType": "", "@schemaLocation": "" }, "resourceCharacteristic": [], "wirelessLocalLoopIndicator": false } } }, "required": true } }, "parameters": [ { "in": "path", "required": true, "name": "id", "schema": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^\\d{10}$" }, "description": "\\{id\\} is the subscriberNumber for which the voicemailbox PIN is being reset." } ] } }, "openapi": "3.0.3", "security": [ { "ATT-Azure-AD-JWT-Token": [] } ], "components": { "links": {}, "schemas": { "lib_Any": {}, "lib_Note": { "type": "object", "required": [ "id", "author", "date", "operationID", "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" }, "operationID": { "type": "string", "description": "Operation ID" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Extra information about a given entity" }, "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." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "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" } }, "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)" }, "lib_Place": { "type": "object", "required": [ "id", "href", "name", "role", "@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\"" }, "role": { "type": "string", "description": "Role of the place (for instance: 'home delivery', 'shop retrieval')" }, "@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" } }, "description": "Place reference. Place defines the places where the products are sold or delivered." }, "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 ." }, "@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" }, "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." }, "@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" } }, "description": "A response to a request" }, "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": { "$ref": "#/components/schemas/lib_Request" }, "response": { "$ref": "#/components/schemas/lib_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" } }, "description": "Monitoring of resources" }, "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." } }, "description": "Configuration feature." }, "lib_Quantity": { "type": "object", "required": [ "amount", "units" ], "properties": { "units": { "type": "string", "description": "Unit" }, "amount": { "type": "number", "format": "float", "default": 1, "description": "Numeric value in a given unit" } }, "description": "An amount in a given unit" }, "lib_PlaceRef": { "type": "object", "required": [ "id", "href", "name", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name 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" }, "@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" } }, "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered." }, "lib_Resource": { "type": "object", "required": [ "id", "href", "category", "description", "endOperatingDate", "name", "resourceVersion", "startOperatingDate", "activationFeature", "administrativeState", "attachment", "note", "operationalState", "place", "relatedParty", "resourceCharacteristic", "resourceRelationship", "resourceSpecification", "resourceStatus", "usageState", "@baseType", "@schemaLocation", "@type" ], "properties": { "id": { "type": "string", "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." }, "href": { "type": "string", "description": "The URI for the object itself." }, "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "$ref": "#/components/schemas/lib_array" }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "$ref": "#/components/schemas/lib_array" }, "usageState": { "$ref": "#/components/schemas/lib_ResourceUsageStateType" }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "$ref": "#/components/schemas/lib_array" }, "resourceStatus": { "$ref": "#/components/schemas/lib_ResourceStatusType" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "$ref": "#/components/schemas/lib_ResourceOperationalStateType" }, "activationFeature": { "allOf": [ { "$ref": "#/components/schemas/lib_array" } ], "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "$ref": "#/components/schemas/lib_ResourceAdministrativeStateType" }, "resourceRelationship": { "$ref": "#/components/schemas/lib_array" }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "$ref": "#/components/schemas/lib_array" } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory." }, "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." }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "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." }, "@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" } }, "description": "A response to a request" }, "lib_EntityRef": { "type": "object", "required": [ "id", "href", "name", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name 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" }, "@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" } }, "description": "Entity reference schema to be use for all entityRef class." }, "lib_TimePeriod": { "type": "object", "required": [ "endDateTime", "startDateTime" ], "properties": { "endDateTime": { "type": "string", "format": "date-time", "example": "1985-04-12T23:20:50.52Z", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "format": "date-time", "example": "1985-04-12T23:20:50.52Z", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "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" } }, "description": "An item typically included in a request or response" }, "lib_Attachment": { "type": "object", "required": [ "id", "href", "attachmentType", "content", "description", "mimeType", "name", "url", "size", "validFor", "@baseType", "@schemaLocation", "@type" ], "properties": { "id": { "type": "string", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Unique identifier for this particular attachment" }, "url": { "type": "string", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "description": { "description": "Uniform Resource Locator, is a web page address (a subset of URI)" } }, "description": "Complements the description of an element (for instance a product) through video, pictures..." }, "lib_ResourceRef": { "type": "object", "required": [ "id", "href", "name", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name 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" }, "@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" } } }, "lib_RelatedParty": { "type": "object", "required": [ "id", "href", "name", "role", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of a related entity." }, "href": { "type": "string", "description": "Reference of the related entity." }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party" }, "@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" }, "@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" } }, "description": "Related Entity reference. A related party defines party or party role linked to a specific entity." }, "lib_Voicemailbox": { "allOf": [ { "$ref": "#/components/schemas/lib_Resource" }, { "type": "object", "properties": { "newPin": { "description": "Personal Identification Number", "type": "string", "minLength": 4, "maxLength": 20 }, "subscriberNumberType": { "description": "When using the phones dialable number use DIALABLE (instead of MSISDN) for both GSM and TDMA. For routing numbers use IMSI for just GSM, or MIN for just TDMA", "type": "string", "enum": [ "DIALABLE", "IMSI", "MIN" ] }, "vmid": { "description": "when client sends vmid, will call snooper adapter directly", "type": "string", "maxLength": 255 }, "wirelessLocalLoopIndicator": { "type": "boolean" }, "code": { "type": "string" } }, "description": "This is a resource used to handle voicemail feature", "required": [ "newPin", "vmid", "wirelessLocalLoopIndicator", "code" ] } ], "description": "This is a resource used to handle voicemail feature" }, "lib_AttachmentRef": { "type": "object", "required": [ "id", "href", "description", "name", "url", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "description": "Unique-Identifier for this attachment" }, "url": { "type": "string", "description": "Link to the attachment media/content" }, "href": { "type": "string", "description": "URL serving as reference for the attachment resource" }, "name": { "type": "string", "description": "Name 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" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "@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" } }, "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures" }, "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" } }, "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec." }, "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": { "$ref": "#/components/schemas/lib_Any" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "@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" }, "characteristicRelationship": { "$ref": "#/components/schemas/lib_array" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "lib_Resource_Create": { "type": "object", "required": [ "category", "description", "endOperatingDate", "name", "resourceVersion", "startOperatingDate", "activationFeature", "administrativeState", "attachment", "note", "operationalState", "place", "relatedParty", "resourceCharacteristic", "resourceRelationship", "resourceSpecification", "resourceStatus", "usageState", "@baseType", "@schemaLocation", "@type" ], "properties": { "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "$ref": "#/components/schemas/lib_array" }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "$ref": "#/components/schemas/lib_array" }, "usageState": { "$ref": "#/components/schemas/lib_ResourceUsageStateType" }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "$ref": "#/components/schemas/lib_array" }, "resourceStatus": { "$ref": "#/components/schemas/lib_ResourceStatusType" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "$ref": "#/components/schemas/lib_ResourceOperationalStateType" }, "activationFeature": { "allOf": [ { "$ref": "#/components/schemas/lib_array" } ], "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "$ref": "#/components/schemas/lib_ResourceAdministrativeStateType" }, "resourceRelationship": { "$ref": "#/components/schemas/lib_array" }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "$ref": "#/components/schemas/lib_array" } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.\nSkipped properties: id,href" }, "lib_Resource_Update": { "type": "object", "required": [ "category", "description", "endOperatingDate", "name", "resourceVersion", "startOperatingDate", "activationFeature", "administrativeState", "attachment", "note", "operationalState", "place", "relatedParty", "resourceCharacteristic", "resourceRelationship", "resourceSpecification", "resourceStatus", "usageState", "@baseType", "@schemaLocation", "@type" ], "properties": { "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "$ref": "#/components/schemas/lib_array" }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "$ref": "#/components/schemas/lib_array" }, "usageState": { "$ref": "#/components/schemas/lib_ResourceUsageStateType" }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "$ref": "#/components/schemas/lib_array" }, "resourceStatus": { "$ref": "#/components/schemas/lib_ResourceStatusType" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "$ref": "#/components/schemas/lib_ResourceOperationalStateType" }, "activationFeature": { "allOf": [ { "$ref": "#/components/schemas/lib_array" } ], "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "$ref": "#/components/schemas/lib_ResourceAdministrativeStateType" }, "resourceRelationship": { "$ref": "#/components/schemas/lib_array" }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "$ref": "#/components/schemas/lib_array" } }, "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.\nSkipped properties: id,href" }, "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." } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "lib_MonitorCreateEvent": { "type": "object", "required": [ "id", "href", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "event" ], "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "description": "The title of the event." }, "event": { "$ref": "#/components/schemas/lib_MonitorCreateEventPayload" }, "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." } }, "description": "The notification data structure" }, "lib_ResourceRefOrValue": { "type": "object", "required": [ "id", "href", "category", "description", "endOperatingDate", "name", "resourceVersion", "startOperatingDate", "activationFeature", "administrativeState", "attachment", "note", "operationalState", "place", "relatedParty", "resourceCharacteristic", "resourceRelationship", "resourceSpecification", "resourceStatus", "usageState", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type." }, "href": { "type": "string", "description": "The URI for the object itself." }, "name": { "type": "string", "description": "A string used to give a name to the resource" }, "note": { "$ref": "#/components/schemas/lib_array" }, "place": { "$ref": "#/components/schemas/lib_RelatedPlaceRefOrValue" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "category": { "type": "string", "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "attachment": { "$ref": "#/components/schemas/lib_array" }, "usageState": { "$ref": "#/components/schemas/lib_ResourceUsageStateType" }, "description": { "type": "string", "description": "free-text description of the resource" }, "relatedParty": { "$ref": "#/components/schemas/lib_array" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "resourceStatus": { "$ref": "#/components/schemas/lib_ResourceStatusType" }, "resourceVersion": { "type": "string", "description": "A field that identifies the specific version of an instance of a resource." }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "endOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date till the resource is operating" }, "operationalState": { "$ref": "#/components/schemas/lib_ResourceOperationalStateType" }, "activationFeature": { "allOf": [ { "$ref": "#/components/schemas/lib_array" } ], "description": "Configuration features" }, "startOperatingDate": { "type": "string", "format": "date-time", "description": "A date time( DateTime). The date from which the resource is operating" }, "administrativeState": { "$ref": "#/components/schemas/lib_ResourceAdministrativeStateType" }, "resourceRelationship": { "$ref": "#/components/schemas/lib_array" }, "resourceSpecification": { "$ref": "#/components/schemas/lib_ResourceSpecificationRef" }, "resourceCharacteristic": { "$ref": "#/components/schemas/lib_array" } }, "description": "A resource to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the product entity and not the RelatedProductRefOrValue class itself" }, "lib_ResourceStatusType": { "type": "string", "enum": [ "standby", "alarm", "available", "reserved", "unknown", "suspended" ], "description": "ResourceStatusType enumerations" }, "lib_MonitorDeleteEvent": { "type": "object", "required": [ "id", "href", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "event" ], "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "description": "The title of the event." }, "event": { "$ref": "#/components/schemas/lib_MonitorDeleteEventPayload" }, "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." } }, "description": "The notification data structure" }, "lib_ResourceDeleteEvent": { "type": "object", "required": [ "id", "href", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "event" ], "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "description": "The title of the event." }, "event": { "$ref": "#/components/schemas/lib_ResourceDeleteEventPayload" }, "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." } }, "description": "The notification data structure" }, "lib_Voicemailbox_Create": { "allOf": [ { "$ref": "#/components/schemas/lib_Resource_Create" }, { "type": "object", "properties": { "newPin": { "description": "Personal Identification Number", "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\d{4,20}$" }, "subscriberNumberType": { "description": "When using the phones dialable number use DIALABLE (instead of MSISDN) for both GSM and TDMA. For routing numbers use IMSI for just GSM, or MIN for just TDMA", "type": "string", "enum": [ "DIALABLE", "IMSI", "MIN" ] }, "vmid": { "description": "when client sends vmid, will call snooper adapter directly", "type": "string", "maxLength": 255 }, "wirelessLocalLoopIndicator": { "type": "boolean" } }, "description": "This is a resource used to handle voicemail feature", "required": [ "newPin", "vmid", "wirelessLocalLoopIndicator" ] } ], "description": "This is a resource used to handle voicemail feature" }, "lib_Voicemailbox_Update": { "allOf": [ { "$ref": "#/components/schemas/lib_Resource_Update" }, { "type": "object", "properties": { "newPin": { "description": "New Personal Identification Number", "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\d{4,20}$" }, "subscriberNumberType": { "description": "When using the phones dialable number use DIALABLE (instead of MSISDN) for both GSM and TDMA. For routing numbers use IMSI for just GSM, or MIN for just TDMA", "type": "string", "enum": [ "DIALABLE" ] }, "vmid": { "description": "when client sends vmid, will call snooper adapter directly", "type": "string", "maxLength": 255 }, "wirelessLocalLoopIndicator": { "type": "boolean" } }, "description": "This is a resource used to handle voicemail feature", "required": [ "newPin", "subscriberNumberType", "vmid", "wirelessLocalLoopIndicator" ] } ], "description": "This is a resource used to handle voicemail feature" }, "lib_ResourceCreateEvent": { "type": "object", "required": [ "id", "href", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "event" ], "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "description": "The title of the event." }, "event": { "$ref": "#/components/schemas/lib_ResourceCreateEventPayload" }, "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." } }, "description": "The notification data structure" }, "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": { "$ref": "#/components/schemas/lib_TimePeriod" }, "@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": "This is the type of the feature relationship." } }, "description": "Configuration feature" }, "lib_ResourceRelationship": { "type": "object", "required": [ "relationshipType", "resource", "@baseType", "@schemaLocation", "@type" ], "properties": { "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "resource": { "$ref": "#/components/schemas/lib_ResourceRefOrValue" }, "@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": "Type of the resource relationship, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (e.g. an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" } }, "description": "Linked resources to the one instantiate, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reliesOn] if the resource needs another already owned resource to rely on (e.g. an option on an already owned mobile access resource) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful" }, "lib_AttachmentRefOrValue": { "type": "object", "required": [ "id", "href", "attachmentType", "content", "description", "mimeType", "name", "url", "size", "validFor", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Unique identifier for this particular attachment" }, "url": { "type": "string", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "Uniform Resource Locator, is a web page address (a subset of URI)" }, "href": { "type": "string", "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "description": "URI for this Attachment" }, "name": { "type": "string", "description": "The name of the attachment" }, "size": { "$ref": "#/components/schemas/lib_Quantity" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "validFor": { "$ref": "#/components/schemas/lib_TimePeriod" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "description": { "type": "string", "example": "Photograph of the Product", "description": "A narrative text describing the content of the attachment" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "attachmentType": { "type": "string", "example": "video", "description": "Attachment type such as video, picture" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself" }, "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." } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "lib_RelatedPlaceRefOrValue": { "type": "object", "required": [ "id", "href", "name", "role", "@baseType", "@schemaLocation", "@type", "@referredType" ], "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\"" }, "role": { "type": "string" }, "@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" }, "@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" } }, "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself" }, "lib_ResourceUsageStateType": { "type": "string", "enum": [ "idle", "active", "busy" ], "description": "ResourceUsageStateType enumerations" }, "lib_MonitorStateChangeEvent": { "type": "object", "required": [ "id", "href", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "event" ], "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "description": "The title of the event." }, "event": { "$ref": "#/components/schemas/lib_MonitorStateChangeEventPayload" }, "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." } }, "description": "The notification data structure" }, "lib_ResourceStateChangeEvent": { "type": "object", "required": [ "id", "href", "eventId", "eventTime", "eventType", "correlationId", "domain", "title", "description", "priority", "timeOcurred", "event" ], "properties": { "id": { "type": "string", "description": "Identifier of the Process flow" }, "href": { "type": "string", "description": "Reference of the ProcessFlow" }, "title": { "type": "string", "description": "The title of the event." }, "event": { "$ref": "#/components/schemas/lib_ResourceStateChangeEventPayload" }, "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." } }, "description": "The notification data structure" }, "lib_ResourceSpecificationRef": { "type": "object", "required": [ "id", "href", "name", "version", "@baseType", "@schemaLocation", "@type", "@referredType" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the resource specification" }, "href": { "type": "string", "description": "Reference of the resource specification" }, "name": { "type": "string", "description": "Name of the requiredResourceSpecification" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" }, "version": { "type": "string", "description": "Resource specification version" }, "@baseType": { "type": "string", "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", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" } }, "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification." }, "lib_MonitorCreateEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "$ref": "#/components/schemas/lib_Monitor" } }, "description": "The event data structure" }, "lib_MonitorDeleteEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "$ref": "#/components/schemas/lib_Monitor" } }, "description": "The event data structure" }, "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" } }, "description": "Another Characteristic that is related to the current Characteristic;" }, "lib_ResourceDeleteEventPayload": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "$ref": "#/components/schemas/lib_Resource" } }, "description": "The event data structure" }, "lib_ResourceCreateEventPayload": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "$ref": "#/components/schemas/lib_Resource" } }, "description": "The event data structure" }, "lib_ResourceOperationalStateType": { "type": "string", "enum": [ "enable", "disable" ], "description": "ResourceOperationalStateType enumerations" }, "lib_MonitorStateChangeEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "$ref": "#/components/schemas/lib_Monitor" } }, "description": "The event data structure" }, "lib_ResourceStateChangeEventPayload": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "$ref": "#/components/schemas/lib_Resource" } }, "description": "The event data structure" }, "lib_ResourceAdministrativeStateType": { "type": "string", "enum": [ "locked", "unlocked", "shutdown" ], "description": "ResourceAdministrativeStateType enumerations" }, "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": { "$ref": "#/components/schemas/lib_MonitorAttributeValueChangeEventPayload" }, "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." } }, "description": "The notification data structure" }, "lib_ResourceAttributeValueChangeEvent": { "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": { "$ref": "#/components/schemas/lib_ResourceAttributeValueChangeEventPayload" }, "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." } }, "description": "The notification data structure" }, "lib_MonitorAttributeValueChangeEventPayload": { "type": "object", "required": [ "monitor" ], "properties": { "monitor": { "$ref": "#/components/schemas/lib_Monitor" } }, "description": "The event data structure" }, "lib_ResourceAttributeValueChangeEventPayload": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "$ref": "#/components/schemas/lib_Resource" } }, "description": "The event data structure" } }, "headers": {}, "examples": {}, "responses": { "trait_jwt_400": { "content": { "application/json": { "example": { "code": "400", "reason": "JWT Token is required", "status": "400-UNAUTHORIZED-TMF702", "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-TMF702", "message": "Invalid token" } } }, "description": "Invalid token." }, "trait_jwt_503": { "content": { "application/json": { "example": { "code": "503", "reason": "Internal Server Error", "status": "503-INTERNAL SERVER_ERROR-TMF702", "message": "Internal Server Error" } } }, "description": "Error communicating with JWKS server." }, "trait_error-responses_400": { "content": { "application/json": { "example": { "code": "400", "reason": "Required header 'Authorization' not specified", "status": "400-BAD_REQUEST-TMF702", "message": "Required header 'Authorization' not specified" } } }, "description": "Bad request to the server." }, "trait_error-responses_401": { "content": { "application/json": { "example": { "code": "401", "reason": "Unauthorized", "status": "401-UNAUTHORIZED-TMF702", "message": "Unauthorized" } } }, "description": "Invalid credentials." }, "trait_error-responses_403": { "content": { "application/json": { "example": { "code": "403", "reason": "Forbidden", "status": "403-FORBIDDEN-TMF702", "message": "Forbidden" } } }, "description": "Issue with the credentials." }, "trait_error-responses_404": { "content": { "application/json": { "example": { "code": "404", "reason": "Requested resource no found.", "status": "404-NOT_FOUND-TMF702", "message": "Requested resource no found." } } }, "description": "Requested resource no found." }, "trait_error-responses_405": { "content": { "application/json": { "example": { "code": "405", "reason": "HTTP Method get not allowed", "status": "405-METHOD_NOT_ALLOWED-TMF702", "message": "HTTP Method get not allowed" } } }, "description": "Requested method not supported." }, "trait_error-responses_406": { "content": { "application/json": { "example": { "code": "406", "error": "Not Acceptable", "reason": "Not Acceptable", "status": "406-UNACCEPTABLE-TMF702" } } }, "description": "Unacceptable request body." }, "trait_error-responses_415": { "content": { "application/json": { "example": { "code": "415", "reason": "Unsupported mediaType", "status": "415-UNSUPPORTED_MEDIA_TYPE-TMF702", "message": "Unsupported mediaType" } } }, "description": "Bad Content-Type header. Unsupported media type." }, "trait_error-responses_500": { "content": { "application/json": { "example": { "code": "500", "reason": "Internal Server Error", "status": "500-INTERNAL SERVER_ERROR-TMF702", "message": "Internal Server Error" } } }, "description": "Processing error for the 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": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "ext_expires_in": { "type": "integer", "format": "int32", "example": 3599 } }, "description": "Dummy token below. Real token is much longer with more relevant info" } } }, "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": "b82bea2f-5ee3-48a4-9774-4143176a6900" }, "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": "b57403ef-e775-49f6-b40f-009ba759c301" }, "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\\nTrace ID: b82bea2f-5ee3-48a4-9774-4143176a6900\\r\\nCorrelation ID: b57403ef-e775-49f6-b40f-009ba759c301\\r\\nTimestamp: 2021-06-30 21:12:34Z" } }, "description": "Only an example of 400 Error body" } } }, "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: https://login.microsoftonline.com/e741d71c-cx03cxxxxxxx56/oauth2/v2.0/token \r\n\r\n See example below.\r\n\r\n\ncurl --location --request POST 'https://login.microsoftonline.com/e741d71c-c6xx3c-xxxxx/oauth2/v2.0/token' \r\n --header 'Content-Type: application/x-www-form-urlencoded' \r\n --header 'Cookie: fpc=Aswi39iZZIlGtV66yM1qCANKExLGAQAAAOqRbtgOAAAA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' \r\n --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' \r\n --data-urlencode 'grant_type=client_credentials' \r\n --data-urlencode 'client_id=6bb2748d-d916-4534-5148-ee8f598e1e00' \r\n --data-urlencode 'client_secret=k_43YrZE2S2v9o6__e.KOKc_V4h__csa3M' \r\n\r\n 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-CorrelationId": { "in": "header", "name": "X-ATT-CorrelationId", "schema": { "type": "string" }, "required": false, "description": "Recommended format is 32 hexadecimal characters GUID (XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)." }, "securityScheme_ATT_Azure_AD_JWT_Token_Authorization": { "in": "header", "name": "Authorization", "schema": { "type": "string" }, "example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "required": true, "description": "JWT Bearer Token" } }, "requestBodies": {}, "securitySchemes": { "ATT_Azure_AD_JWT_Token": { "type": "oauth2", "flows": { "authorizationCode": { "scopes": {}, "tokenUrl": "https://login.microsoftonline.com/e741d71c-cxxxxxxxx2b07556/oauth2/v2.0/token", "authorizationUrl": "https://login.microsoftonline.com/e741d71c-cxxxxxxxxx2b07556/oauth2/v2.0/token" } }, "description": "Get a JWT Token from AT&T's Azure AD" } } } }