You can call the API directly from a REST client or use the API in integrations with other applications.", "version":"2026.04.28", "termsOfService":"https://www.oracle.com/legal/terms.html", "x-summary":"Use the Oracle Communications Unified Inventory Management (UIM) REST API for Resource Inventory Management (TMF 639) and Service Inventory Management (TMF 638)." }, "tags":[ { "name":"Impact Analysis", "description":"Retrieve impact analysis data for various network resources.", "x-displayName":"Impact Analysis" }, { "name":"Impact Analysis/Subnode Information", "description":"Retrieve subnode information.", "x-displayName":"Impact Analysis/Subnode Information" }, { "name":"Reconfigure Network Resources/Groom", "description":"Create and Process groom activities.", "x-displayName":"Reconfigure Network Resources/Groom" }, { "name":"Reconfigure Network Resources/Rehome", "description":"Create and Process rehome activities.", "x-displayName":"Reconfigure Network Resources/Rehome" }, { "name":"Reconfigure Network Resources/ReplaceCard", "description":"Create and Process replace card activities.", "x-displayName":"Reconfigure Network Resources/ReplaceCard" }, { "name":"Resource", "description":"Create, get, update and delete UIM resources, such as equipment, logical devices, telephone numbers, and IP networks.", "x-displayName":"Resource" }, { "name":"Resource Reservation", "description":"Reserve, unreserve, get and update reservations", "x-displayName":"Resource Reservation" }, { "name":"Resource/Connectivity", "description":"Create, get, update, process and delete Connectivity", "x-displayName":"Resource/Connectivity" }, { "name":"Resource/Custom Network Address", "description":"Create, get, update and delete custom network addresses.", "x-displayName":"Resource/Custom Network Address" }, { "name":"Resource/Custom Object", "description":"Create, get, update and delete custom objects.", "x-displayName":"Resource/Custom Object" }, { "name":"Resource/Device Interface", "description":"Create, get, update and delete device interfaces.", "x-displayName":"Resource/Device Interface" }, { "name":"Resource/Equipment", "description":"Create, get, update and delete equipment.", "x-displayName":"Resource/Equipment" }, { "name":"Resource/Equipment Holder", "description":"Get and update equipment holders.", "x-displayName":"Resource/Equipment Holder" }, { "name":"Resource/Equipment/Associated Resources", "description":"Get resources associated with equipment.", "x-displayName":"Resource/Equipment/Associated Resources" }, { "name":"Resource/EquipmentHolder", "x-displayName":"Resource/EquipmentHolder" }, { "name":"Resource/Flow Identifier", "description":"Create, get, update and delete flow identifiers.", "x-displayName":"Resource/Flow Identifier" }, { "name":"Resource/IP Address", "description":"Create, get, update and delete IP addresses.", "x-displayName":"Resource/IP Address" }, { "name":"Resource/IP Network", "description":"Create, get, update and delete IP networks.", "x-displayName":"Resource/IP Network" }, { "name":"Resource/IP Subnet", "description":"Create, get, update and delete IP subnets.", "x-displayName":"Resource/IP Subnet" }, { "name":"Resource/IP Subnet/Associated Resources", "description":"Get resources associated with IP subnets.", "x-displayName":"Resource/IP Subnet/Associated Resources" }, { "name":"Resource/IPv4 Address", "x-displayName":"Resource/IPv4 Address" }, { "name":"Resource/IPv6 Address", "x-displayName":"Resource/IPv6 Address" }, { "name":"Resource/Logical Device", "description":"Create, get, update and delete logical devices.", "x-displayName":"Resource/Logical Device" }, { "name":"Resource/Logical Device Account", "description":"Create, get, update and delete logical device accounts.", "x-displayName":"Resource/Logical Device Account" }, { "name":"Resource/Logical Device/Associated Resources", "description":"Get resources associated with logical devices.", "x-displayName":"Resource/Logical Device/Associated Resources" }, { "name":"Resource/Network Address Domain", "description":"Create, get, update and delete network address domains.", "x-displayName":"Resource/Network Address Domain" }, { "name":"Resource/Physical Connector", "description":"Create, get, update and delete physical connectors.", "x-displayName":"Resource/Physical Connector" }, { "name":"Resource/Physical Device", "description":"Create, get, update and delete logical devices.", "x-displayName":"Resource/Physical Device" }, { "name":"Resource/Physical Device/Associated Resources", "description":"Get resources associated with physical devices.", "x-displayName":"Resource/Physical Device/Associated Resources" }, { "name":"Resource/Physical Port", "description":"Create, get, update and delete physical ports.", "x-displayName":"Resource/Physical Port" }, { "name":"Resource/Pipe", "description":"Create, get, update and delete Pipes.", "x-displayName":"Resource/Pipe" }, { "name":"Resource/Pipe Termination Point", "description":"Get and update Pipe Termination Point.", "x-displayName":"Resource/Pipe Termination Point" }, { "name":"Resource/Pipe/Pipe Termination Points", "description":"Get termination points with pipe.", "x-displayName":"Resource/Pipe/Pipe Termination Points" }, { "name":"Resource/Telephone Number", "description":"Create, get, update and delete telephone numbers.", "x-displayName":"Resource/Telephone Number" }, { "name":"Retrieve Paths/Connectivity", "description":"Get enabling paths of Connectivity.", "x-displayName":"Retrieve Paths/Connectivity" }, { "name":"Retrieve Paths/Pipe", "description":"Get enabling paths of Pipe.", "x-displayName":"Retrieve Paths/Pipe" }, { "name":"Service", "description":"Create, get, update and process services.", "x-displayName":"Service" }, { "name":"Service/Bundle", "description":"Create, get, update and process Bundle Service.", "x-displayName":"Service/Bundle" } ], "paths":{ "/service":{ "get":{ "operationId":"listService", "summary":"Get Services", "description":"Gets all services that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n
The includeAll query parameter is required to list all services, including CFS and RFS. The default includes only CFS.
\n \n
The criteria can include these properties:
\n
\nThese criteria operators can be used on the filtering properties. Equals operator is supported for all filtering properties. RegEx operator is supported only on service characteristic searches.Service characteristic search is applicable only on Service Chars and not Service Configuration Item Chars. Operators can be string literals or URL-encoded format. serviceDate filter can be used with operators equals, less than equals and greater than equals.\n
For example: state=active (OR) state==active (OR) state%3D%3Dactive (OR) state.eq=active
For example: name.regex=^broadband (OR) name*=^broadband (OR) name*=%5Ebroadband
For Example: name.regex=broadband$ (OR) name*=broadband$ (OR) name*=broadband%24
For example: name.regex=^.*broadband (OR) name*=^.*broadband (OR) name*=%5E.*broadband
Optionally, use the expand parameter to specify any service relationships (or) supporting services (expand=supportingService,serviceRelationship)that you want to see details for. By default, you'll just see links for these.\n\n
To view additional details of resource, party, place set expand to supportingResource, relatedParty and/or place respectively(expand=supportingResource,relatedParty,place).\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n\n
Optionally, use the sort parameter to sort the search results.
\nUsage: sort=(Direction)Fields\n
where Direction is '-' for descending order, and '+' for ascending order. For example: sort=-id,name\n
These fields can be sorted:\n
\n", "tags":[ "Service" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"includeAll", "schema":{ "type":"boolean" }, "in":"query", "description":"Set to true to search for all services including CFS and RFS. By default service search includes only CFS." }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The services were retrieved successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Service" } } } } }, "206":{ "description":"A range of services were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Service" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-get", "x-filename-id":"service-get" }, "post":{ "operationId":"createService", "summary":"Create a Service", "description":"Creates a service with the given details.\nsupportingService property is not allowed as part of createService request body. supportingService is managed by DesignAndAssign custom code.\nIt auto creates service configuration and moves to designed or completed state based on state attribute provided in the input.
The following fields are mandatory fields for successful creation: \n
\n
\n", "tags":[ "Service" ], "parameters":[ { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The service to be created", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "responses":{ "201":{ "description":"The service was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-post", "x-filename-id":"service-post" } }, "/service/{id}":{ "get":{ "operationId":"retrieveService", "summary":"Get a Service by ID", "description":"Gets the service that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any service relationships (or) supporting services (expand=supportingService,serviceRelationship)that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Service" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the service to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The service was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-{id}-get", "x-filename-id":"service-id-get" }, "delete":{ "operationId":"deleteService", "summary":"Delete a Service", "description":"This operation deletes a Service entity.", "tags":[ "Service" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the service to delete." } ], "responses":{ "204":{ "description":"The resource was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-{id}-delete", "x-filename-id":"service-id-delete" }, "patch":{ "operationId":"updateService", "summary":"Update a Service", "description":"Updates the Service that matches the specified ID. Update can be performed using merge-patch. Kindly note that ID and ServiceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values. \nIf designOnly flag is true, then service will be in designed state otherwise it moves to completed state.\nService can be suspended/resumed/terminated using PATCH by providing the required \"state\" in input request. For suspend and resume service action, designOnly param is not required.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any service relationships that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Service" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the service to update." }, { "name":"designOnly", "schema":{ "type":"boolean" }, "in":"query", "description":"This flag is used to control activation flow of the service. When it is 'true', service is designed with patched attributes but it is not activated. When it is 'false', service is designed with patched attributes and sequentially Approve/Issue/Activate requests are executed and moves service state to active." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The service to be updated", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "responses":{ "200":{ "description":"The service was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-{id}-patch", "x-filename-id":"service-id-patch" } }, "/service/updateResource":{ "post":{ "operationId":"updateConsumerServices", "summary":"Reverse Update of Consumable Resource", "description":"Updates existing resources of the services with new resources provided in the input. The services to be updated can be filtered using the\ncriteria.
The includeAll query parameter is required to update all services, including CFS and RFS. The default includes only CFS.
\n
The service filtering criteria can include these properties:
\n
\n", "tags":[ "Service" ], "parameters":[ { "name":"id", "required":false, "schema":{ "type":"string" }, "in":"query", "description":"Optional Service ID's , comma separated values, on which resource updates to be made." }, { "name":"filterAssignAndRefState", "required":false, "schema":{ "type":"string" }, "in":"query", "description":"Filter on assignment and reference states with comma separated values. Valid values are ASSIGNED,PENDING_ASSIGN,REFERENCED,PENDING_REFERENCED. Ex:If ASSIGNED,REFERENCED is provided in filter then only resources with these assignment states are updated with new resources. Default includes all above mentioned states." }, { "name":"filterServiceState", "required":false, "schema":{ "type":"string" }, "in":"query", "description":"Filter on service states with comma separated values. Valid values are ACTIVE, DESIGNED, INACTIVE. Ex:If ACTIVE is provided in filter then only services with these states are considered for updates. By default updates happen only for ACTIVE,DESIGNED,INACTIVE. Services with states TERMINATED,CANCELLED,PENDING_CANCEL, PENDING_DISCONNECT and CANCELPENDINGDISCONNECT are not considered for updates." }, { "name":"filterConfigurationState", "required":false, "schema":{ "type":"string" }, "in":"query", "description":"Filter on configuration state with comma separated values. Valid values are COMPLETED, IN_PROGRESS, DESIGNED, ISSUED. Ex:If COMPLETED is provided in filter then only latest service configuration with these states are considered for updates." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The existing resources of the services will be updated with new resources.", "required":true, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/UpdateConsumableResource" } } } } }, "responses":{ "200":{ "description":"The services were updated successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Service" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-updateResource-post", "x-filename-id":"service-updateresource-post" } }, "/service/{id}/{task}":{ "post":{ "operationId":"processService", "summary":"Process a Service", "description":"This operation processes a Service entity for a given task. Possible tasks are APPROVE, ISSUE, ACTIVATE and CANCEL. \n
The following values are the possible tasks to process a service:
\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any service relationships (or) supporting services (expand=supportingService,serviceRelationship)that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n", "tags":[ "Service" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the service to process." }, { "name":"task", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The task of the service to process. Possible tasks are APPROVE, ISSUE, ACTIVATE and CANCEL." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The service was processed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-{id}-{task}-post", "x-filename-id":"service-id-task-post" } }, "/service/externalId/{extId}":{ "patch":{ "operationId":"updateServiceByExternalId", "summary":"Update a Service by External identity", "description":"Updates the Service that matches the specified external identity (externalObjectId + externalManagementDomain).\nInternally resolves the Service ID and reuses the existing merge-patch processing.\n
Attribute selection is enabled for all first-level attributes.
\n", "tags":[ "Service" ], "parameters":[ { "name":"extId", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The external object id of the service to update." }, { "name":"domain", "required":false, "schema":{ "type":"string" }, "in":"query", "description":"The external management domain of the service to update. If not provided, search by externalObjectId only." }, { "name":"designOnly", "schema":{ "type":"boolean" }, "in":"query", "description":"This flag is used to control activation flow of the service. When it is 'true', service is designed with patched attributes but it is not activated. When it is 'false', service is designed with patched attributes and sequentially Approve/Issue/Activate requests are executed and moves service state to active." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The service to be updated", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "responses":{ "200":{ "description":"The service was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-externalId-{extId}-patch", "x-filename-id":"service-externalid-extid-patch" } }, "/service/externalId/{extId}/{task}":{ "post":{ "operationId":"processTaskByExternalId", "summary":"Process a Service by External Identity", "description":"Processes a Service that matches the specified external identity for a given task. This route internally resolves the Service ID and reuses the existing process task processing. Possible tasks are APPROVE, ISSUE, ACTIVATE and CANCEL.
Attribute selection is enabled for all first-level attributes.\n", "tags":[ "Service" ], "parameters":[ { "name":"extId", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The external object id of the service to process." }, { "name":"task", "required":true, "schema":{ "type":"string", "enum":[ "APPROVE", "ISSUE", "ACTIVATE", "CANCEL" ] }, "in":"path", "description":"The task to process on the service. Possible values are APPROVE, ISSUE, ACTIVATE, CANCEL." }, { "name":"domain", "required":false, "schema":{ "type":"string" }, "in":"query", "description":"The external management domain of the service. If not provided, search by externalObjectId only." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The service was processed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Service" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"service-externalId-{extId}-{task}-post", "x-filename-id":"service-externalid-extid-task-post" } }, "/bundle":{ "post":{ "operationId":"createOrUpdateBundleService", "summary":"Create or Update a Bundle Service", "description":"Create or Update a Bundle Service based on id provided in the input. Create a bundle service when id is not provided in the input, otherwise it will update the existing bundle service. \nIf designOnly flag is true, then bundle service will be in designed state otherwise it moves to completed state.\n
Create a bundle service with the given details incase of bundle id is not provided in input. The following fields are mandatory fields in each of the bundle service items for successful creation: \n
\n
\nUpdation of bundle service can be performed when bundle id provided in the input. Kindly note that id,description,name,supportingResource,relatedParty,serviceCharacteristic,place,externalIdentity are the only attributes to be passed under each of the items during updation of bundle service.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any service relationships that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Service/Bundle" ], "parameters":[ { "name":"designOnly", "schema":{ "type":"boolean" }, "in":"query", "description":"This flag is used to control activation flow. When it is 'true', changes applied but not activated. When it is 'false', changes applied and sequentially Approve/Issue/Activate requests executed to activate changes." } ], "requestBody":{ "description":"The Bundle service to be created", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BundleService" } } } }, "responses":{ "201":{ "description":"The bundle service was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BundleService" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"bundle-post", "x-filename-id":"bundle-post" } }, "/bundle/{id}/{task}":{ "post":{ "operationId":"processBundleService", "summary":"Process a Bundle Service", "description":"This operation processes a Bundle Service entity. Possible tasks are APPROVE, ISSUE, ACTIVATE and CANCEL.\n
The following values are the possible tasks to process a bundle service:
\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any service relationships (or) supporting services (expand=supportingService,serviceRelationship)that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n", "tags":[ "Service/Bundle" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the bundle service to process." }, { "name":"task", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The task of the bundle service to process. Possible tasks are APPROVE, ISSUE, ACTIVATE and CANCEL." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The bundle service was processed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BundleService" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"bundle-{id}-{task}-post", "x-filename-id":"bundle-id-task-post" } }, "/bundle/{id}":{ "get":{ "operationId":"retrieveBundleService", "summary":"Get a Bundle Service by ID", "description":"Gets the bundle service that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any service relationships (or) supporting services (expand=supportingService,serviceRelationship)that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Service/Bundle" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the bundle service to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The bundle service was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BundleService" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"bundle-{id}-get", "x-filename-id":"bundle-id-get" } }, "/resource":{ "get":{ "operationId":"retrieveResources", "summary":"Get Resources", "description":"Gets all resources that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n
The @type query parameter is required for optimal results.
\n \n
The criteria can include these properties:
\n
\nThese criteria operators can be used on the filtering properties. Operators can be string literals or URL-encoded format.\n
For example: lifecycleState=UNASSIGNED (OR) lifecycleState==UNASSIGNED (OR) lifecycleState%3D%3DUNASSIGNED lifecycleState.eq=UNASSIGNED
For example: startDate.gte=2013-04-20 (OR) startDate>=2013-04-20 (OR) startDate %3E%3D2013-04-20
startDate.lte=2013-04-20 (OR) startDate<=2013-04-20 (OR) startDate %3C%3D2013-04-20
For example: vendorPortName.regex=!cisco (OR) vendorPortName*=!cisco
For example: vendorPortName.regex=^cisco (OR) vendorPortName*=^cisco (OR) vendorPortName*=%5Ecisco
For Example: vendorPortName.regex=cisco$ (OR) vendorPortName*=cisco$ (OR) vendorPortName*=cisco%24
For example: vendorPortName.regex=^.*cisco (OR) vendorPortName*=^.*cisco (OR) vendorPortName*=%5E.*cisco
Optionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT,resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, and resourceRelationship.MAPPEDTO) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n\n
Optionally, use the sort parameter to sort the search results.
\nUsage: sort=(Direction)Fields\n
where Direction is '-' for descending order, and '+' for ascending order. For example: sort=-id,name\n
These fields can be sorted:\n
\n", "tags":[ "Resource" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The resources were retrieved successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceBase" } } } } }, "206":{ "description":"A range of resources were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceBase" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resource-get", "x-filename-id":"resource-get" }, "post":{ "operationId":"createResource", "summary":"Create a Resource", "description":"Creates a resource with the given details. The following fields are mandatory fields for successful creation:\n
\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type.
\nThe created resource will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n
Additional attributes could be required for specific resources and the details are provided in POST PATH of concrete resources. For example, physicalDeviceRef is mandatory for creating physical ports.\n", "tags":[ "Resource" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The Resource to be created", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceBase" } } } }, "responses":{ "201":{ "description":"The resource was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceBase" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resource-post", "x-filename-id":"resource-post" } }, "/resource/{id}":{ "get":{ "operationId":"retrieveResource", "summary":"Get a Resource by ID", "description":"Gets the resource that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships that you want to see details for (for example, resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, and resourceRelationship.MAPPEDTO). By default, you'll just see links for these relationships.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the resource to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The resource was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceBase" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resource-{id}-get", "x-filename-id":"resource-id-get" }, "delete":{ "operationId":"deleteResource", "summary":"Delete a Resource", "description":"Deletes the resource that matches the specified ID.", "tags":[ "Resource" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the resource to delete." } ], "responses":{ "204":{ "description":"The resource was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resource-{id}-delete", "x-filename-id":"resource-id-delete" }, "patch":{ "operationId":"updateResource", "summary":"Update a Resource", "description":"Updates the resource that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships that you want to see details for (for example, resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, and resourceRelationship.MAPPEDTO). By default, you'll just see links for these relationships.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the resource to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The resource to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/ResourceBase" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The resource was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceBase" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resource-{id}-patch", "x-filename-id":"resource-id-patch" } }, "/logicalDeviceAccount":{ "get":{ "operationId":"retrieveLogicalDeviceAccounts", "summary":"Get Logical Device Accounts", "description":"Gets all logical device accounts that match the search criteria in the query parameters.
Attribute selection is enabled for all first-level attributes.\n\n
The filtering criteria can include:\n
For information about the filter operators, see Get Resources.
\n
\nOptionally, use the expand parameter to specify any resource relationships that you want to see details for (for example, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE). By default, you'll see links for these resource relationships.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Logical Device Account" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The logical device accounts were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } } }, "206":{ "description":"A range of logical device accounts were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical device account wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDeviceAccount-get", "x-filename-id":"logicaldeviceaccount-get" }, "post":{ "operationId":"createLogicalDeviceAccount", "summary":"Create Logical Device Accounts", "description":"Creates one or more logical device accounts with the given details. To create multiple logical device accounts, include the quantity parameter set to the number to create. If you create multiple logical device accounts, they will all have the same details.
The following fields are mandatory for successful creation: \n
\n
\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type. The relationship type can be ASSOCIATES or INVOLVE. \nThe created logical device account will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Logical Device Account" ], "parameters":[ { "$ref":"#/components/parameters/quantity" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The logical device account to be created.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } }, "responses":{ "201":{ "description":"The logical device accounts were created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDeviceAccount-post", "x-filename-id":"logicaldeviceaccount-post" } }, "/logicalDeviceAccount/{id}":{ "get":{ "operationId":"retrieveLogicalDeviceAccount", "summary":"Get a Logical Device Account by ID", "description":"Gets the logical device account that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Logical Device Account" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the logical device account." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The logical device account was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical device account wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDeviceAccount-{id}-get", "x-filename-id":"logicaldeviceaccount-id-get" }, "patch":{ "operationId":"mergeLogicalDeviceAccount", "summary":"Update a Logical Device Account", "description":"Updates the Logical Device Account that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n", "tags":[ "Resource/Logical Device Account" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the logical device account to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The logical device account to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The logical device account was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDeviceAccount-{id}-patch", "x-filename-id":"logicaldeviceaccount-id-patch" }, "delete":{ "operationId":"deleteLogicalDeviceAccount", "summary":"Delete a Logical Device Account", "description":"Deletes the logical device account that matches the specified ID.", "tags":[ "Resource/Logical Device Account" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the logical device account." } ], "responses":{ "204":{ "description":"The logical device account was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical device account wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDeviceAccount-{id}-delete", "x-filename-id":"logicaldeviceaccount-id-delete" } }, "/logicalDevice":{ "get":{ "operationId":"retrieveLogicalDevices", "summary":"Get Logical Devices", "description":"Gets all logical devices that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Logical Device" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The logical devices were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDevice" } } } } }, "206":{ "description":"A range of logical devices were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDevice" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical devices weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-get", "x-filename-id":"logicaldevice-get" }, "post":{ "operationId":"createLogicalDevice", "summary":"Create Logical Devices", "description":"Creates one or more logical devices with the given details. To create multiple logical devices, include the quantity parameter set to the number to create. When creating multiple logical devices, they will all have the same details.
The following fields are mandatory fields for successful creation: \n
\n
\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type. When creating multiple logical devices, only PARENT and INVOLVE relationship types can be provided.\nThe created logical device will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Logical Device" ], "parameters":[ { "$ref":"#/components/parameters/quantity" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The logical device to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDevice" } } } }, "responses":{ "201":{ "description":"The logical devices were created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDevice" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-post", "x-filename-id":"logicaldevice-post" } }, "/logicalDevice/{id}":{ "get":{ "operationId":"retrieveLogicalDevice", "summary":"Get a Logical Device by ID", "description":"Gets the logical device that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Logical Device" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the logical device to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The logical device was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDevice" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical device wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-{id}-get", "x-filename-id":"logicaldevice-id-get" }, "patch":{ "operationId":"mergeLogicalDevice", "summary":"Update a Logical Device", "description":"Updates the Logical Device that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Logical Device" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the logical device to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The logical device to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/LogicalDevice" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The logical device was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDevice" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-{id}-patch", "x-filename-id":"logicaldevice-id-patch" }, "delete":{ "operationId":"deleteLogicalDevice", "summary":"Delete a Logical Device", "description":"Deletes the logical device that matches the specified ID.", "tags":[ "Resource/Logical Device" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the logical device to delete." } ], "responses":{ "204":{ "description":"The logical device was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical device wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-{id}-delete", "x-filename-id":"logicaldevice-id-delete" } }, "/logicalDevice/{id}/deviceInterfaces":{ "get":{ "operationId":"retrieveDeviceInterfacesForLD", "summary":"Get Device Interfaces by Logical Device", "description":"Gets all device interfaces that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Logical Device/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the logical device." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The device interfaces were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceInterface" } } } } }, "206":{ "description":"A range of device interfaces were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceInterface" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The device interfaces weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-{id}-deviceInterfaces-get", "x-filename-id":"logicaldevice-id-deviceinterfaces-get" } }, "/logicalDevice/{id}/logicalDeviceAccounts":{ "get":{ "operationId":"retrieveLogicalDeviceAccountsForLD", "summary":"Get Logical Device Accounts by Logical Device", "description":"Gets all logical device accounts that match the logical device ID.
Attribute selection is enabled for all first-level attributes.\n
For information about the filter operators, see Get Resources.
\n \n\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Logical Device/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the logical device." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The logial device accounts were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } } }, "206":{ "description":"A range of logical device accounts were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalDeviceAccount" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical device accounts weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-{id}-logicalDeviceAccounts-get", "x-filename-id":"logicaldevice-id-logicaldeviceaccounts-get" } }, "/logicalDevice/updateNetworkEntityLocation/{id}":{ "post":{ "operationId":"updateNetworkEntityLocation", "summary":"Move Logical Device with Consumers from one Property Location to another Property Location", "description":"Updates existing logical device from one Property Location to a new Property Location in the input. Updates the information on consumers i.e, Connectivities and Pipe.\n", "tags":[ "Resource/Logical Device" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the logical device to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The existing property location of the services will be updated with new property location.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PlaceRef" } } } }, "responses":{ "200":{ "description":"The existing logical device is returned with update property location successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDevice" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The logical device wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"logicalDevice-updateNetworkEntityLocation-{id}-post", "x-filename-id":"logicaldevice-updatenetworkentitylocation-id-post" } }, "/deviceInterface":{ "get":{ "operationId":"retrieveDeviceInterfaces", "summary":"Get Device Interfaces", "description":"Gets all device interfaces that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, and resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Device Interface" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The device interfaces were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceInterface" } } } } }, "206":{ "description":"A range of device interfaces were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceInterface" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The device interfaces weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"deviceInterface-get", "x-filename-id":"deviceinterface-get" }, "post":{ "operationId":"createDeviceInterface", "summary":"Create Device Interfaces", "description":"Creates one or more device interfaces for a given logical device. To create multiple device interfaces, use the quantity parameter to specify the number to create.
The following fields are mandatory fields for successful creation: \n
\n
\n
To create a resource relationship, the resourceRelationship.type and resourceRelationship.resourceRef fields are mandatory. The created logical device account will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Device Interface" ], "parameters":[ { "$ref":"#/components/parameters/quantity" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The device interface to be created", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeviceInterface" } } } }, "responses":{ "201":{ "description":"The device interface were created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceInterface" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"deviceInterface-post", "x-filename-id":"deviceinterface-post" } }, "/deviceInterface/{id}":{ "get":{ "operationId":"retrieveDeviceInterface", "summary":"Get a Device Interface by ID", "description":"Gets the device interface that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Device Interface" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the device interface to delete." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The device interface was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeviceInterface" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The device interface wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"deviceInterface-{id}-get", "x-filename-id":"deviceinterface-id-get" }, "patch":{ "operationId":"mergeDeviceInterface", "summary":"Update a Device Interface", "description":"Updates the Device Interface that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Device Interface" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the device interface to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The device interface to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/DeviceInterface" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The device interface was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeviceInterface" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"deviceInterface-{id}-patch", "x-filename-id":"deviceinterface-id-patch" }, "delete":{ "operationId":"deleteDeviceInterface", "summary":"Delete a Device Interface", "description":"Deletes the device interface that matches the specified ID.", "tags":[ "Resource/Device Interface" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the device interface to delete." } ], "responses":{ "204":{ "description":"The device interface was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The device interface wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"deviceInterface-{id}-delete", "x-filename-id":"deviceinterface-id-delete" } }, "/physicalDevice":{ "get":{ "operationId":"retrievePhysicalDevices", "summary":"Get Physical Devices", "description":"Gets all physical devices that match the search criteria specified in the query parameter.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
You can also sort by networkLocation. For information about sorting details, see Get Resources.
\n \n", "tags":[ "Resource/Physical Device" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical devices were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalDevice" } } } } }, "206":{ "description":"A range of physical devices were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalDevice" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical devices weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalDevice-get", "x-filename-id":"physicaldevice-get" }, "post":{ "operationId":"createPhysicalDevice", "summary":"Create a Physical Device", "description":"Creates a Physical Device with the given details. The following fields are mandatory fields for successful PhysicalDevice creation. \n
\n
\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain minimum details of id and @type.\nThe created Physical Device will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Physical Device" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The physical device to be created.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalDevice" } } } }, "responses":{ "201":{ "description":"The physical device was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalDevice" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalDevice-post", "x-filename-id":"physicaldevice-post" } }, "/physicalDevice/{id}":{ "get":{ "operationId":"retrievePhysicalDevice", "summary":"Get a Physical Device by ID", "description":"Gets the physical device that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Physical Device" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical device to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical device was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalDevice" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical device wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalDevice-{id}-get", "x-filename-id":"physicaldevice-id-get" }, "delete":{ "operationId":"deletePhysicalDevice", "summary":"Delete a Physical Device", "description":"Deletes the physical device that matches the specified ID.", "tags":[ "Resource/Physical Device" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the physical device to delete." } ], "responses":{ "204":{ "description":"The physical device was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physcial device wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalDevice-{id}-delete", "x-filename-id":"physicaldevice-id-delete" }, "patch":{ "operationId":"mergePhysicalDevice", "summary":"Update a Physical Device", "description":"Updates the Physical Device that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Physical Device" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical device to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The physical device to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/PhysicalDevice" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The physical device was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalDevice" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalDevice-{id}-patch", "x-filename-id":"physicaldevice-id-patch" } }, "/physicalDevice/{id}/physicalPorts":{ "get":{ "operationId":"retrievePhysicalPortsForDevice", "summary":"Get Physical Ports by Physical Device", "description":"Gets all physical ports that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
\nFor information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Physical Device/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical device." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical port was returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalPort" } } } } }, "206":{ "description":"A range of physical ports were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalPort" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical port wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalDevice-{id}-physicalPorts-get", "x-filename-id":"physicaldevice-id-physicalports-get" } }, "/physicalDevice/{id}/physicalConnectors":{ "get":{ "operationId":"retrievePhysicalConnectorsForDevice", "summary":"Get Physical Connectors by Physical Device", "description":"Gets all physical connectors that match the specified physical device.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Physical Device/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical device." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical connector was returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalConnector" } } } } }, "206":{ "description":"A range of phyical connectors were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalConnector" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical connector wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalDevice-{id}-physicalConnectors-get", "x-filename-id":"physicaldevice-id-physicalconnectors-get" } }, "/physicalPort":{ "get":{ "operationId":"retrievePhysicalPorts", "summary":"Get Physical Ports", "description":"Gets all physical ports that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO) or equipmentRef, physicalDeviceRef that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Physical Port" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical ports were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalPort" } } } } }, "206":{ "description":"A range of physical ports were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalPort" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical ports weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalPort-get", "x-filename-id":"physicalport-get" }, "post":{ "operationId":"createPhysicalPorts", "summary":"Create a Physical Port", "description":"Creates a Physical Ports with the given details. The following fields are mandatory fields for successful PhysicalPort creation. \n
\n
Optionally quantity queryParam can be used for bulk creation of ports.\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain minimum details of id and @type.\nThe created Physical Port will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Physical Port" ], "parameters":[ { "$ref":"#/components/parameters/quantity" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The physical port to be created.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalPort" } } } }, "responses":{ "201":{ "description":"The physical ports were created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalPort" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalPort-post", "x-filename-id":"physicalport-post" } }, "/physicalPort/{id}":{ "get":{ "operationId":"retrievePhysicalPort", "summary":"Get Physical Port by ID", "description":"Gets the physical port that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO) or equipmentRef, physicalDeviceRef that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Physical Port" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical port to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical port was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalPort" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical port wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalPort-{id}-get", "x-filename-id":"physicalport-id-get" }, "patch":{ "operationId":"mergePhysicalPort", "summary":"Update a Physical Port", "description":"Updates the Physical Port that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO) or equipmentRef, physicalDeviceRef that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Physical Port" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical port to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The physical port to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/PhysicalPort" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The physical port was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalPort" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalPort-{id}-patch", "x-filename-id":"physicalport-id-patch" }, "delete":{ "operationId":"deletePhysicalPort", "summary":"Delete a Physical Port", "description":"Deletes the physical port that matches the specified ID.", "tags":[ "Resource/Physical Port" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the physical port to delete." } ], "responses":{ "204":{ "description":"The physical port was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical port wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalPort-{id}-delete", "x-filename-id":"physicalport-id-delete" } }, "/physicalConnector":{ "get":{ "operationId":"retrievePhysicalConnectors", "summary":"Get Physical Connectors", "description":"Gets all physical connectors that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE) or equipmentRef, physicalDeviceRef that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Physical Connector" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical connectors were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalConnector" } } } } }, "206":{ "description":"A range of physical connectors were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalConnector" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical connectors weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalConnector-get", "x-filename-id":"physicalconnector-get" }, "post":{ "operationId":"createPhysicalConnectors", "summary":"Create a Physical Connector", "description":"Creates a physical connector with the given details. The following fields are mandatory fields for successful creation: \n
\n
Optionally quantity queryParam can be used for bulk creation of connectors.\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain minimum details of id and @type.\nThe created physical connector will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Physical Connector" ], "parameters":[ { "$ref":"#/components/parameters/quantity" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The physical connector to be created", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalConnector" } } } }, "responses":{ "201":{ "description":"The physical connectors were created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalConnector" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalConnector-post", "x-filename-id":"physicalconnector-post" } }, "/physicalConnector/{id}":{ "get":{ "operationId":"retrievePhysicalConnector", "summary":"Get a Physical Connector by ID", "description":"Gets the physical connector that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE) or equipmentRef, physicalDeviceRef that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Physical Connector" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical connector to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical connector was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalConnector" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical connector wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalConnector-{id}-get", "x-filename-id":"physicalconnector-id-get" }, "patch":{ "operationId":"mergePhysicalConnector", "summary":"Update a Physical Connector", "description":"Updates the Physical Connector that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE) or equipmentRef, physicalDeviceRef that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Physical Connector" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the physical connector to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The physical connector to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/PhysicalConnector" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The physical connector was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalConnector" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalConnector-{id}-patch", "x-filename-id":"physicalconnector-id-patch" }, "delete":{ "operationId":"deletePhysicalConnector", "summary":"Delete a Physical Connector", "description":"Deletes the physical connector that matches the specified ID.", "tags":[ "Resource/Physical Connector" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the physical connector to delete." } ], "responses":{ "204":{ "description":"The physical connector was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical connector wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"physicalConnector-{id}-delete", "x-filename-id":"physicalconnector-id-delete" } }, "/equipment":{ "get":{ "operationId":"retrieveEquipments", "summary":"Get Equipment", "description":"Gets all equipment that matches the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details.
\n", "tags":[ "Resource/Equipment" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The equipment was returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Equipment" } } } } }, "206":{ "description":"A range of equipment was returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Equipment" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The equipment wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipment-get", "x-filename-id":"equipment-get" }, "post":{ "operationId":"createEquipments", "summary":"Create an Equipment Entity", "description":"Creates an equipment entity with the given details.
The following fields are mandatory fields for successful equipment creation: \n
\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type.\n
The created equipment will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Equipment" ], "parameters":[ { "$ref":"#/components/parameters/quantity" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The equipment to be created.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Equipment" } } } }, "responses":{ "201":{ "description":"The equipment is created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Equipment" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipment-post", "x-filename-id":"equipment-post" } }, "/equipment/{id}":{ "get":{ "operationId":"retrieveEquipment", "summary":"Get an Equipment Entity by ID", "description":"Gets the equipment entity that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Equipment" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the equipment to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The equipment was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Equipment" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The equipment wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipment-{id}-get", "x-filename-id":"equipment-id-get" }, "patch":{ "operationId":"mergeEquipment", "summary":"Update an Equipment", "description":"Updates the Equipment that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Equipment" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the equipment to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The equipment to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/Equipment" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The equipment was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Equipment" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipment-{id}-patch", "x-filename-id":"equipment-id-patch" }, "delete":{ "operationId":"deleteEquipment", "summary":"Delete an Equipment Entity", "description":"Deletes the equipment entity that matches the specified ID.", "tags":[ "Resource/Equipment" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the equipment to delete." } ], "responses":{ "204":{ "description":"The equipment was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The equipment wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipment-{id}-delete", "x-filename-id":"equipment-id-delete" } }, "/equipment/{id}/physicalPorts":{ "get":{ "operationId":"retrievePhysicalPortsForEquipment", "summary":"Get Physical Ports by Equipment", "description":"Gets all physical ports that match the specified equipment ID.
Attribute selection is enabled for all first-level attributes.
\nYou can filter the list by:\n\n
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE and resourceRelationship.MAPPEDTO) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Equipment/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID for the equipment." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical ports were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalPort" } } } } }, "206":{ "description":"A range of physical ports were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalPort" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical ports weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipment-{id}-physicalPorts-get", "x-filename-id":"equipment-id-physicalports-get" } }, "/equipment/{id}/physicalConnectors":{ "get":{ "operationId":"retrievePhysicalConnectorsForEquipment", "summary":"Get Physical Connectors by Equipment", "description":"Gets all physical connectors that match the specified equipment ID.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Equipment/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the equipment." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The physical connectors were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalConnector" } } } } }, "206":{ "description":"A range of physical connectors were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PhysicalConnector" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The physical connectors weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipment-{id}-physicalConnectors-get", "x-filename-id":"equipment-id-physicalconnectors-get" } }, "/equipmentHolder":{ "get":{ "operationId":"retrieveEquipmentHolders", "summary":"Get Equipment Holders", "description":"Gets all equipment holders that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Equipment Holder" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The equipment holders were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/EquipmentHolder" } } } } }, "206":{ "description":"A range of equipment holders were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/EquipmentHolder" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The equipment holders weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipmentHolder-get", "x-filename-id":"equipmentholder-get" } }, "/equipmentHolder/{id}":{ "get":{ "operationId":"retrieveEquipmentHolder", "summary":"Get Equipment Holder by ID", "description":"Gets the equipment holder that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Equipment Holder" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the equipment holder to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The equipment holder was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EquipmentHolder" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The equipment holder wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipmentHolder-{id}-get", "x-filename-id":"equipmentholder-id-get" }, "patch":{ "operationId":"mergeEquipmentHolder", "summary":"Update an EquipmentHolder", "description":"Updates the Equipment Holder that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/EquipmentHolder" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the equipment Holder to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "requestBody":{ "description":"The equipment Holder to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/EquipmentHolder" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The equipment Holder was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EquipmentHolder" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"equipmentHolder-{id}-patch", "x-filename-id":"equipmentholder-id-patch" } }, "/telephoneNumber":{ "get":{ "operationId":"retrieveTelephoneNumbers", "summary":"Get Telephone Numbers", "description":"Gets all telephone numbers that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Telephone Number" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The telephone numbers were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/TelephoneNumber" } } } } }, "206":{ "description":"A range of telephone numbers were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/TelephoneNumber" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The telephone numbers weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"telephoneNumber-get", "x-filename-id":"telephonenumber-get" }, "post":{ "operationId":"createTelephoneNumber", "summary":"Create Telephone Numbers", "description":"Creates a telephone number with given details. The operation also supports creation of a range of TelephoneNumbers, for which rangeFrom and rangeTo query params canbe given. The following fields are mandatory fields for successful Telephone Number creation. \n
\n
\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. The created Telephone Number will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Telephone Number" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "required":false, "name":"rangeFrom", "schema":{ "type":"string" }, "in":"query", "description":"The starting range for the telephone numbers" }, { "required":false, "name":"rangeTo", "schema":{ "type":"string" }, "in":"query", "description":"The ending range for the telephone numbers" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The telephone number to be created.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TelephoneNumber" } } } }, "responses":{ "201":{ "description":"The telephone numbers were created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/TelephoneNumber" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"telephoneNumber-post", "x-filename-id":"telephonenumber-post" } }, "/telephoneNumber/{id}":{ "get":{ "operationId":"retrieveTelephoneNumber", "summary":"Get a Telephone Number by ID", "description":"Gets the telephone number that matches the specified ID.
Attribute selection is enabled for all first-level attributes.", "tags":[ "Resource/Telephone Number" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the telephone number to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The telephone number was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TelephoneNumber" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The telephone number wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"telephoneNumber-{id}-get", "x-filename-id":"telephonenumber-id-get" }, "patch":{ "operationId":"mergeTelephoneNumber", "summary":"Update a Telephone Number", "description":"Updates the Telephone Number that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.\n", "tags":[ "Resource/Telephone Number" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Telephone Number to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The Telephone Number to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/TelephoneNumber" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The Telephone Number was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TelephoneNumber" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"telephoneNumber-{id}-patch", "x-filename-id":"telephonenumber-id-patch" }, "delete":{ "operationId":"deleteTelephoneNumber", "summary":"Delete a Telephone Number", "description":"Deletes the telephone number that matches the specified ID.", "tags":[ "Resource/Telephone Number" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the telephone number to delete." } ], "responses":{ "204":{ "description":"The telephone number was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The telephone number wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"telephoneNumber-{id}-delete", "x-filename-id":"telephonenumber-id-delete" } }, "/customObject":{ "get":{ "operationId":"retrieveCustomObjects", "summary":"Get Custom Objects", "description":"Gets all custom objects that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Custom Object" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The custom objects were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomObject" } } } } }, "206":{ "description":"A range of custom objects were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomObject" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The custom objects weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customObject-get", "x-filename-id":"customobject-get" }, "post":{ "operationId":"createCustomObject", "summary":"Create a Custom Object", "description":"Creates a custom object with the given details. The following fields are mandatory fields for successful custom object creation: \n
\n
To create resource relationships, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type.\n
The created custom object will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Custom Object" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The custom object to be created.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomObject" } } } }, "responses":{ "201":{ "description":"The custom object was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomObject" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customObject-post", "x-filename-id":"customobject-post" } }, "/customObject/{id}":{ "get":{ "operationId":"retrieveCustomObject", "summary":"Get a Custom Object by ID", "description":"Gets the custom object that matches the specificed ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT,resourceRelationship.CHILD, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced (related) entities. If depth=0, all referenced entities in RootEntity objects will contain only ID, HREF, and @type. If depth = N, it expands reference objects of related entities recursively. The last level contains only the references. By default, depth=0.\n
\n", "tags":[ "Resource/Custom Object" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the custom object to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The custom object was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomObject" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The custom object wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customObject-{id}-get", "x-filename-id":"customobject-id-get" }, "patch":{ "operationId":"mergeCustomObject", "summary":"Update a Custom Object", "description":"Updates the custom object that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT,resourceRelationship.CHILD, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced (related) entities. If depth=0, all referenced entities in RootEntity objects will contain only ID, HREF, and @type. If depth = N, it expands reference objects of related entities recursively. The last level contains only the references. By default, depth=0.\n
\n", "tags":[ "Resource/Custom Object" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Custom Object to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The Custom Object to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/CustomObject" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The Custom Object was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomObject" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customObject-{id}-patch", "x-filename-id":"customobject-id-patch" }, "delete":{ "operationId":"deleteCustomObject", "summary":"Delete a Custom Object", "description":"Deletes the custom object that matches the specified ID.", "tags":[ "Resource/Custom Object" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the custom object to delete." } ], "responses":{ "204":{ "description":"The custom object was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The custom object wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customObject-{id}-delete", "x-filename-id":"customobject-id-delete" } }, "/customNetworkAddress":{ "get":{ "operationId":"retrieveCustomNetworkAddresses", "summary":"Get Custom Network Addresses", "description":"Gets all custom network addresses that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.
\nThe filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Custom Network Address" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The custom network addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomNetworkAddress" } } } } }, "206":{ "description":"A range of custom network addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomNetworkAddress" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The custom network addresses weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customNetworkAddress-get", "x-filename-id":"customnetworkaddress-get" }, "post":{ "operationId":"createCustomNetworkAddress", "summary":"Create a Custom Network Address", "description":"Creates a custom network address with the given details. The following fields are mandatory fields for successful creation: \n
\n
To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type.\nThe created custom network address will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Custom Network Address" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The custom network address to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomNetworkAddress" } } } }, "responses":{ "201":{ "description":"The custom network address was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomNetworkAddress" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customNetworkAddress-post", "x-filename-id":"customnetworkaddress-post" } }, "/customNetworkAddress/{id}":{ "get":{ "operationId":"retrieveCustomNetworkAddress", "summary":"Get a Custom Network Address by ID", "description":"Gets the custom network address that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Custom Network Address" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the custom network address to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The custom network address was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomNetworkAddress" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The custom network address wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customNetworkAddress-{id}-get", "x-filename-id":"customnetworkaddress-id-get" }, "patch":{ "operationId":"mergeCustomNetworkAddress", "summary":"Update a Custom Network Address", "description":"Updates the custom network address that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, and resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Custom Network Address" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Custom Network Address to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The Custom Network Address to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/CustomNetworkAddress" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The Custom Network Address was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CustomNetworkAddress" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customNetworkAddress-{id}-patch", "x-filename-id":"customnetworkaddress-id-patch" }, "delete":{ "operationId":"deleteCustomNetworkAddress", "summary":"Delete a Custom Network Address", "description":"Deletes the custom network address that matches the specified ID.", "tags":[ "Resource/Custom Network Address" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the custom network address to delete." } ], "responses":{ "204":{ "description":"The custom network address was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The custom network address wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customNetworkAddress-{id}-delete", "x-filename-id":"customnetworkaddress-id-delete" } }, "/ipNetwork":{ "get":{ "operationId":"retrieveIPNetworks", "summary":"Get IP Networks", "description":"Gets all IP networks, including IPv4 and IPv6, that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n
The version query parameter is required for identifying the IP version of the network to get.
\n \nYou can include these properties:
\n
For information about the filter operators, see Get Resources.
\n\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n\n
Optionally, use the sort parameter to sort the search results.\n
Usage: sort=(Direction)Fields\n
where Direction is '-' for descending order, and '+' for ascending order. For example: sort=-name, name
\n
\n", "tags":[ "Resource/IP Network" ], "parameters":[ { "required":true, "name":"version", "schema":{ "type":"string" }, "in":"query", "description":"The version of the IP network." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The IP networks were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPNetwork" } } } } }, "206":{ "description":"A range of IP networks were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPNetwork" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IP networks weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipNetwork-get", "x-filename-id":"ipnetwork-get" }, "post":{ "operationId":"createIPNetwork", "summary":"Create an IP Network", "description":"Creates an IP network with the given details. The natural subnet for the network is also created.\n
The following fields are mandatory fields for successful creation: \n
\nThe created IP network will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/IP Network" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The IP Network to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPNetwork" } } } }, "responses":{ "201":{ "description":"The IP Network was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPNetwork" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipNetwork-post", "x-filename-id":"ipnetwork-post" } }, "/ipNetwork/{id}":{ "get":{ "operationId":"retrieveIPNetwork", "summary":"Get an IP Network by ID", "description":"Gets the IP network that matches the specified ID. The ID for an IP network is a composite of three different attributes: IPAddress-PrefixLength-IPAddressDomainName.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IP Network" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "allowReserved":true, "description":"The ID of the IP network to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The IP network was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPNetwork" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IP network wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipNetwork-{id}-get", "x-filename-id":"ipnetwork-id-get" }, "patch":{ "operationId":"mergeIPNetwork", "summary":"Update a IP Network", "description":"Updates the IP Network that matches the specified ID. The ID for an IP network is a composite of three different attributes: IPAddress-PrefixLength-IPAddressDomainName.
Attribute selection is enabled for all first-level attributes.
Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IP Network" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the IP Network to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The IP Network to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/IPNetwork" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The IP Network was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPNetwork" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipNetwork-{id}-patch", "x-filename-id":"ipnetwork-id-patch" }, "delete":{ "operationId":"deleteIPNetwork", "summary":"Delete an IP Network", "description":"Deletes the IP network that matches the specified ID.", "tags":[ "Resource/IP Network" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the IP network to delete." } ], "responses":{ "204":{ "description":"The IP network was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IP network wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipNetwork-{id}-delete", "x-filename-id":"ipnetwork-id-delete" } }, "/ipSubnet":{ "get":{ "operationId":"retrieveIPSubnets", "summary":"Get IP Subnets", "description":"Gets all IP subnets, including IPv4 and IPv6, that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n
The version query parameter is required for identifying the IP version of the network to get.
\nThe filtering criteria for IPv4 subnets can include below properties and the properties generic to resource. Properties generic to resource and usage of the filtering operators can be referred to GET PATH of /resource.
\n
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced (related) entities. If depth=0, all referenced entities in RootEntity objects contain only ID, HREF, and @type. If depth = N, it expands the reference objects of related entities recursively. The last level contains only the references.\n\n
Optionally, use the sort parameter to sort the search results.
Usage: sort=(Direction)Fields
where Direction is '-' for descending order and '+' for ascending order.
For example, sort=-name, name\n
Sorting can be performed on these fields:
\n", "tags":[ "Resource/IP Subnet" ], "parameters":[ { "required":true, "name":"version", "schema":{ "type":"string" }, "in":"query" }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The IP subnets were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPSubnet" } } } } }, "206":{ "description":"A range of IP subnets were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPSubnet" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IP networks weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipSubnet-get", "x-filename-id":"ipsubnet-get" } }, "/ipSubnet/{id}":{ "get":{ "operationId":"retrieveIPSubnet", "summary":"Get an IP Subnet by ID", "description":"Gets the IP subnet that matches the specified ID. The ID for IP subnets is a composite of three different attributes: IPAddress-PrefixLength-IPAddressDomainName.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IP Subnet" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "allowReserved":true, "description":"The ID of the IP subnet to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The IP subnet was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPSubnet" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IP subnet wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipSubnet-{id}-get", "x-filename-id":"ipsubnet-id-get" }, "patch":{ "operationId":"mergeIPSubnet", "summary":"Update an IP Subnet", "description":"Updates the IP Subnet that matches the specified ID. The ID for IP subnets is a composite of three different attributes: IPAddress-PrefixLength-IPAddressDomainName. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IP Subnet" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the flow identifier to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "requestBody":{ "description":"The flow identifier to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/IPSubnet" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The flow identifier was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPSubnet" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipSubnet-{id}-patch", "x-filename-id":"ipsubnet-id-patch" } }, "/ipSubnet/IPV4/{id}/ipAddresses":{ "get":{ "operationId":"retrieveIPv4AddressesForSubnet", "summary":"Get IPv4 Addresses by IP Subnet", "description":"Gets the IPv4 addresses that match the specified IP subnet ID.
Attribute selection is enabled for all first-level attributes.
", "tags":[ "Resource/IP Subnet/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the IP subnet." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The IPv4 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV4Address" } } } } }, "206":{ "description":"A range of IPv4 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV4Address" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv4 address wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipSubnet-IPV4-{id}-ipAddresses-get", "x-filename-id":"ipsubnet-ipv4-id-ipaddresses-get" } }, "/ipSubnet/IPV6/{id}/ipAddresses":{ "get":{ "operationId":"retrieveIPv6AddressesForSubnet", "summary":"Get IPv6 Addresses by IP Subnet", "description":"Gets the IPv6 addresses that match the specified IP subnet ID.
Attribute selection is enabled for all first-level attributes.", "tags":[ "Resource/IP Subnet/Associated Resources" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the IP subnet." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The IPv6 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV6Address" } } } } }, "206":{ "description":"A range of IPv6 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV6Address" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv6 addresses weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipSubnet-IPV6-{id}-ipAddresses-get", "x-filename-id":"ipsubnet-ipv6-id-ipaddresses-get" } }, "/ipv4Address":{ "get":{ "operationId":"retrieveIPv4Addresses", "summary":"Get IPv4 Addresses", "description":"Gets all IPv4 addresses that match the specified criteria.
Attribute selection is enabled for all first-level attributes.", "tags":[ "Resource/IP Address" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The IPv4 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV4Address" } } } } }, "206":{ "description":"A range of IPv4 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV4Address" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv4 addresses weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv4Address-get", "x-filename-id":"ipv4address-get" }, "post":{ "operationId":"createIPv4Address", "summary":"Create IPv4 Addresses", "description":"Creates one IPv4 address with the given details by default.
To create a range of IPv4 addresses, include the toAddress query parameter. In this case, the ipAddress attribute is used as the from-Address.
The minimum required parameters are: \n
\nThe created IPv4 addresses will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request. When a range of IP addresses are created, the location header will point to the parent subnet of the created addresses. The same relationships will be created for all addresses in the range.\n", "tags":[ "Resource/IP Address" ], "parameters":[ { "required":false, "name":"toAddress", "schema":{ "type":"string" }, "in":"query" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The Resource to be created", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPV4Address" } } } }, "responses":{ "201":{ "description":"The Ipv4 address was created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV4Address" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv4Address-post", "x-filename-id":"ipv4address-post" } }, "/ipv4Address/{id}":{ "get":{ "operationId":"retrieveIPv4Address", "summary":"Get an IPv4 Address by ID", "description":"Gets the IPv4 address that matches the specified ID. The ID for the IP address is a composite of two attributes: IPAddress-IPAddressDomainName.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IP Address" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "allowReserved":true, "description":"The ID of the IPv4 address to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The IPv4 address was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPV4Address" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv4 address wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv4Address-{id}-get", "x-filename-id":"ipv4address-id-get" }, "delete":{ "operationId":"deleteIPv4Address", "summary":"Delete an IPv4 Address", "description":"Deletes the IPv4 address that matches the specified ID.", "tags":[ "Resource/IP Address" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the IPv4 address to delete." } ], "responses":{ "204":{ "description":"The IPv4 address was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv4 address wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv4Address-{id}-delete", "x-filename-id":"ipv4address-id-delete" }, "patch":{ "operationId":"mergeIPv4Address", "summary":"Update an IPv4 Address", "description":"Updates the IPv4 Address that matches the specified ID. The ID for the IP address is a composite of two attributes: IPAddress-IPAddressDomainName. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IPv4 Address" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the flow identifier to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The flow identifier to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/IPV4Address" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The flow identifier was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPV4Address" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv4Address-{id}-patch", "x-filename-id":"ipv4address-id-patch" } }, "/ipv6Address":{ "get":{ "operationId":"retrieveIPv6Addresses", "summary":"Get IPv6 Addresses", "description":"Gets all IPv6 addresses.
Attribute selection is enabled for all first-level attributes.", "tags":[ "Resource/IP Address" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The IPv6 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV6Address" } } } } }, "206":{ "description":"A range of IPv6 addresses were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV6Address" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv6 addresses weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv6Address-get", "x-filename-id":"ipv6address-get" }, "post":{ "operationId":"createIPv6Address", "summary":"Create an IPv6 Address", "description":"Creates an IPv6 address with the given details. When the toAddress query parameter is provided, a range of IPv6 addresses are created with the same given details. The ipAddress attribute is considered as the from-Address. The following attributes are mandatory for successful creation: \n
\nThe created IPv6 addresses will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.
When a range of IPv6 addresses are created, the location header will point to the parent subnet of the created addresses. The same relationships will be created for all addresses in the range.\n", "tags":[ "Resource/IP Address" ], "parameters":[ { "required":false, "name":"toAddress", "schema":{ "type":"string" }, "in":"query" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The Ipv6 address to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPV6Address" } } } }, "responses":{ "201":{ "description":"The IPv6 address was created successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPV6Address" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv6Address-post", "x-filename-id":"ipv6address-post" } }, "/ipv6Address/{id}":{ "get":{ "operationId":"retrieveIPv6Address", "summary":"Get an IPv6 Address by ID", "description":"Gets the IPv6 address that matches the specified ID. The ID for the IP address is a composite of two attributes: IPAddress-IPAddressDomainName.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IP Address" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "allowReserved":true, "description":"The ID of the IPv6 address to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The IPv6 address was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPV6Address" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv6 address wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv6Address-{id}-get", "x-filename-id":"ipv6address-id-get" }, "delete":{ "operationId":"deleteIPv6Address", "summary":"Delete an IPv6 Address", "description":"Deletes the IPv6 address that matches the specified ID.", "tags":[ "Resource/IP Address" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the IPv6 address to delete." } ], "responses":{ "204":{ "description":"The IPv6 address was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The IPv6 address wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv6Address-{id}-delete", "x-filename-id":"ipv6address-id-delete" }, "patch":{ "operationId":"mergeIPv6Address", "summary":"Update an IPv6 Address", "description":"Updates the IPv6 Address that matches the specified ID. The ID for the IP address is a composite of two attributes: IPAddress-IPAddressDomainName. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes. \n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE, resourceRelationship.CONSUMER) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/IPv6 Address" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the flow identifier to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The flow identifier to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/IPV6Address" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The flow identifier was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IPV6Address" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"ipv6Address-{id}-patch", "x-filename-id":"ipv6address-id-patch" } }, "/networkAddressDomain":{ "get":{ "operationId":"retrieveNetworkAddressDomains", "summary":"Get Network Address Domains", "description":"Gets all network address domains that match the search criteria in the query parameters.\n
Attribute selection is enabled for all first-level attributes.\n
You can filter network address domains by:
\n
For more information about the filter operators, see Get Resources.
\nOptionally, use the sort parameter to sort the search results.\n
Usage: sort=(Direction)Fields\n
where Direction is '-' for descending order, and '+' for ascending order.
For example: sort=-name, name
\n
You can sort these fields:\n
The following fields are mandatory fields for successful Network Address domain creation. \n
\nThe created NAD will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Network Address Domain" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The network address domain to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NetworkAddressDomain" } } } }, "responses":{ "201":{ "description":"The network address domain was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NetworkAddressDomain" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"networkAddressDomain-post", "x-filename-id":"networkaddressdomain-post" } }, "/networkAddressDomain/{id}":{ "get":{ "operationId":"retrieveNetworkAddressDomain", "summary":"Get a Network Address Domain by ID", "description":"Gets all network address domains that match the specified ID. The ID is used interchangeably with the name of the domain.\n
Attribute selection is enabled for all first-level attributes.\n
\n", "tags":[ "Resource/Network Address Domain" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "allowReserved":true, "description":"The ID of the network address domain to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The network address domain was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NetworkAddressDomain" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The network address domain wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"networkAddressDomain-{id}-get", "x-filename-id":"networkaddressdomain-id-get" }, "patch":{ "operationId":"mergeNetworkAddressDomain", "summary":"Update a Network Address Domain", "description":"Updates the Network Address Domain that matches the specified ID. The ID is used interchangeably with the name of the domain. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes. The ID is used interchangeably with the name of the domain.\n
Attribute selection is enabled for all first-level attributes.\n
\n", "tags":[ "Resource/Network Address Domain" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Network Address Domain to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The Network Address Domain to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/NetworkAddressDomain" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The Custom Object was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NetworkAddressDomain" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"networkAddressDomain-{id}-patch", "x-filename-id":"networkaddressdomain-id-patch" }, "delete":{ "operationId":"deleteNetworkAddressDomain", "summary":"Delete a Network Address Domain", "description":"Deletes the network address domain that matches the specified ID.", "tags":[ "Resource/Network Address Domain" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the network address domain to delete." } ], "responses":{ "204":{ "description":"The network address domain was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"networkAddressDomain-{id}-delete", "x-filename-id":"networkaddressdomain-id-delete" } }, "/flowIdentifier":{ "get":{ "operationId":"retrieveFlowIdentifiers", "summary":"Get Flow Identifiers", "description":"Gets all flow identifiers that match the search criteria specified in the query parameters.\n
Attribute selection is enabled for all first-level attributes.\n
You can filter the flow identifiers by:\n
\n
For more information about the filter operators, see Get Resources.
\nOptionally, use the sort parameter to sort the search results.\n
Usage: sort=(Direction)Fields\n
where Direction is '-' for descending order, and '+' for ascending order.
For example: sort=-name, name
\nYou can sort these fields:\n
\n", "tags":[ "Resource/Flow Identifier" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The flow identifiers were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/FlowIdentifier" } } } } }, "206":{ "description":"A range of flow identifiers were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/FlowIdentifier" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The flow identifiers weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"flowIdentifier-get", "x-filename-id":"flowidentifier-get" }, "post":{ "operationId":"createFlowIdentifier", "summary":"Create a Flow Identifier", "description":"Creates a flow identifier with the given details.\n
The following fields are mandatory fields for successful flow identifier creation: \n
\nThe created flow identifier will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n", "tags":[ "Resource/Flow Identifier" ], "parameters":[ { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The flow identifier to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FlowIdentifier" } } } }, "responses":{ "201":{ "description":"The flow identifier was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FlowIdentifier" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"flowIdentifier-post", "x-filename-id":"flowidentifier-post" } }, "/flowIdentifier/{id}":{ "get":{ "operationId":"retrieveFlowIdentifier", "summary":"Get a Flow Identifier by ID", "description":"Gets the flow identifier that matches the specified ID. The ID is used interchangeably with the domain name. \n
Note: Flow Identifier should be URL encoded to avoid a malicious request.
\nAttribute selection is enabled for all first-level attributes.\n
\n", "tags":[ "Resource/Flow Identifier" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "allowReserved":true, "description":"The ID of the flow identifier to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The flow identifier was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FlowIdentifier" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The flow identifier wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"flowIdentifier-{id}-get", "x-filename-id":"flowidentifier-id-get" }, "patch":{ "operationId":"mergeFlowIdentifier", "summary":"Update a Flow Identifier", "description":"Updates the Flow Identifier that matches the specified ID. The ID is used interchangeably with the domain name. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Note: Flow Identifier should be URL encoded to avoid a malicious request.
\nAttribute selection is enabled for all first-level attributes.\n
\n", "tags":[ "Resource/Flow Identifier" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the flow identifier to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The flow identifier to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/FlowIdentifier" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The flow identifier was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/FlowIdentifier" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"flowIdentifier-{id}-patch", "x-filename-id":"flowidentifier-id-patch" }, "delete":{ "operationId":"deleteFlowIdentifier", "summary":"Delete a Flow Identifier", "description":"Deletes the flow identifier that matches the specified ID.", "tags":[ "Resource/Flow Identifier" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the flow identifier to delete." } ], "responses":{ "204":{ "description":"The flow identifier was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"flowIdentifier-{id}-delete", "x-filename-id":"flowidentifier-id-delete" } }, "/pipe":{ "get":{ "operationId":"retrievePipes", "summary":"Get Pipes", "description":"Gets all pipes that match the search criteria specified in the query parameter.
Attribute selection is enabled for all first-level attributes.\n \n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n \n", "tags":[ "Resource/Pipe" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The pipe were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Pipe" } } } } }, "206":{ "description":"A range of pipes were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Pipe" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The pipes weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipe-get", "x-filename-id":"pipe-get" }, "post":{ "operationId":"createPipe", "summary":"Create Pipes", "description":"Creates one or more pipes with given details. To create multiple child pipes, use the quantity parameter to specify the number to create and the parent pipe parentPipeRef. The following fields are mandatory fields for successful pipe creation:\n
\n
To create resource relationships, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type.\n
The created pipe will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n
During creation of pipe, both aendTerminationPoint and zendTerminationPoint will be auto created. Pipe Enablement has to be done via PATCH Request.\n", "tags":[ "Resource/Pipe" ], "parameters":[ { "$ref":"#/components/parameters/quantity" }, { "$ref":"#/components/parameters/fields" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The pipe to be created.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Pipe" } } } }, "responses":{ "201":{ "description":"The pipe was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Pipe" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipe-post", "x-filename-id":"pipe-post" } }, "/pipe/{id}":{ "get":{ "operationId":"retrievePipe", "summary":"Get a Pipe by ID", "description":"Gets the pipe that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Pipe" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the pipe to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The pipe was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Pipe" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The pipe wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipe-{id}-get", "x-filename-id":"pipe-id-get" }, "delete":{ "operationId":"deletePipe", "summary":"Delete a Pipe", "description":"Deletes the Pipe that matches the specified ID.", "tags":[ "Resource/Pipe" ], "parameters":[ { "required":true, "name":"id", "in":"path", "schema":{ "type":"string" }, "description":"The ID of the pipe to delete." } ], "responses":{ "204":{ "description":"The pipe was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipe-{id}-delete", "x-filename-id":"pipe-id-delete" }, "patch":{ "operationId":"mergePipe", "summary":"Update a Pipe", "description":"Updates the Pipe that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\nAuto Updation of both Originating and Terminating Termination Point will be done in case of not provided or wrongly provided in the input.\nFor JSON patch, only ADD and REMOVE operation is supported for enablements. Also, only REPLACE operation is supported for capacityProvided and capacityRequired pipe attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Pipe" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the pipe to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "requestBody":{ "description":"The pipe to be updated.", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/Pipe" } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } } } }, "responses":{ "200":{ "description":"The pipe was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Pipe" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipe-{id}-patch", "x-filename-id":"pipe-id-patch" } }, "/pipeTerminationPoint/{id}":{ "get":{ "operationId":"retrievePipeTerminationPoint", "summary":"Get a Pipe Termination Point", "description":"Gets the PipeTerminationPoint that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Pipe Termination Point" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the pipe to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "responses":{ "200":{ "description":"The PipeTerminationPoint was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PipeTerminationPoint" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The pipe wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipeTerminationPoint-{id}-get", "x-filename-id":"pipeterminationpoint-id-get" }, "patch":{ "operationId":"mergePipeTerminationPoint", "summary":"Update a Pipe Termination Point", "description":"Updates the PipeTerminationPoint that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID cannot be updated and must not be provided in the PATCH requests.
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Resource/Pipe Termination Point" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the PipeTerminationPoint to be updated." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" } ], "requestBody":{ "description":"The pipe terminationpoint to be updated.", "required":true, "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/PatchRequest" } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/PipeTerminationPoint" } } } }, "responses":{ "200":{ "description":"The Pipe Termination Point was updated successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PipeTerminationPoint" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipeTerminationPoint-{id}-patch", "x-filename-id":"pipeterminationpoint-id-patch" } }, "/pipe/{id}/terminationPoints":{ "get":{ "operationId":"retrievePipeTerminationPointsForPipe", "summary":"Get Pipe Termination Points by Pipe", "description":"Gets all PipeTerminationPoints for a Pipe that matches an ID specified in the path parameter.
Attribute selection is enabled for all first-level attributes.\n \n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.\n\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nFor information about sorting details, see Get Resources.
\n", "tags":[ "Resource/Pipe/Pipe Termination Points" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the pipe." }, { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The PipeTerminationPoints were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PipeTerminationPoint" } } } } }, "206":{ "description":"A range of PipeTerminationPoints were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PipeTerminationPoint" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The PipeTerminationPoint weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"pipe-{id}-terminationPoints-get", "x-filename-id":"pipe-id-terminationpoints-get" } }, "/connectivity":{ "get":{ "operationId":"retrieveConnectivities", "summary":"Get Connectivities", "description":"Gets all connectivities that match the search criteria specified in the query parameters.
Attribute selection is enabled for all first-level attributes.\n
The filtering criteria can include:
\n
For information about the filter operators, see Get Resources.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.INVOLVE ) that you want to see details for. By default, you'll just see links for these.\n
\n
Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
Sorting Operation is not supported for Connectivities
\n", "tags":[ "Resource/Connectivity" ], "parameters":[ { "$ref":"#/components/parameters/offset" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The connectivities were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Connectivity" } } } } }, "206":{ "description":"A range of connectivities were returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Connectivity" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The connectivities weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"connectivity-get", "x-filename-id":"connectivity-get" }, "post":{ "operationId":"createConnectivity", "summary":"Create a Connectivity", "description":"Creates a Connectivity with the given details.\n
The following fields are mandatory fields for successful Connectivity creation : \n
\nNOTE: The created connectivity will be shown in the response along with the location URL, except when \"fields=none\" is provided in the request.\n
\nIf there are any specific attributes related to the specific connectivity type, then provide the @type values as per below list.\n
\nMultiplexedConnectivity(connectivity type) -> ChannelizedConnectivity(@type value)\n
\nEthernetUNIConnectivity(connectivity type) -> EthernetUNIConnectivity(@type value)\n
\nEthernetINNIConnectivity(connectivity type) -> EthernetINNIConnectivity(@type value)\n
\nEthernetENNIConnectivity(connectivity type) -> EthernetENNIConnectivity(@type value)\n
\nServiceConnectivity(connectivity type) -> ServiceConnectivity(@type value)\n
\nPacketNetworkAccessConnectivity(connectivity type) -> PacketNetworkAccessConnectivity(@type value)\n
\nPacketNetworkConnectivity(connectivity type) -> PacketNetworkConnectivity(@type value)\n",
"tags":[
"Resource/Connectivity"
],
"parameters":[
{
"$ref":"#/components/parameters/quantity"
},
{
"$ref":"#/components/parameters/fields"
},
{
"name":"decryptAttributes",
"example":"ALL",
"schema":{
"type":"string"
},
"in":"query",
"description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is."
}
],
"requestBody":{
"description":"The connectivity to create.",
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Connectivity"
}
}
}
},
"responses":{
"201":{
"description":"The connectivity was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Connectivity"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"connectivity-post",
"x-filename-id":"connectivity-post"
}
},
"/connectivity/{connectivityIdentifier}":{
"get":{
"operationId":"retrieveConnectivity",
"summary":"Get a Connectivity by Connectivity Identifier or ID",
"description":"Gets the connectivity that matches the specified connectivityIdentifier or id. \n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nNOTE: {connectivityIdentifier} in path parameter can be connectivityIdentifier or Id of the connectivity.\n", "tags":[ "Resource/Connectivity" ], "parameters":[ { "required":true, "name":"connectivityIdentifier", "schema":{ "type":"string" }, "in":"path", "description":"The identifier of the connectivity to get." }, { "$ref":"#/components/parameters/fields" }, { "$ref":"#/components/parameters/depth" }, { "$ref":"#/components/parameters/expand" }, { "name":"decryptAttributes", "example":"ALL", "schema":{ "type":"string" }, "in":"query", "description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is." } ], "responses":{ "200":{ "description":"The connectivity was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Connectivity" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The Connectivity wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"connectivity-{connectivityIdentifier}-get", "x-filename-id":"connectivity-connectivityidentifier-get" }, "patch":{ "operationId":"mergeConnectivity", "summary":"Update a Connectivity", "description":"Updates the Connectivity that matches the specified connectivityIdentifier or id. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that only below attributes can be updated and all other non-editable attributes must not be provided in the PATCH requests:\n
Merge Patch:
All attributes provided in the request will be updated with the given values.
JSON Patch:
This operation performs sequential updates on individual attributes.\n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationships (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\nNOTE: {connectivityIdentifier} in path parameter can be connectivityIdentifier or Id of the connectivity.\n
\nIf there are any specific attributes related to the specific connectivity type, then provide the @type values as per below list.\n
\nMultiplexedConnectivity(connectivity type) -> ChannelizedConnectivity(@type value)\n
\nEthernetUNIConnectivity(connectivity type) -> EthernetUNIConnectivity(@type value)\n
\nEthernetINNIConnectivity(connectivity type) -> EthernetINNIConnectivity(@type value)\n
\nEthernetENNIConnectivity(connectivity type) -> EthernetENNIConnectivity(@type value)\n
\nServiceConnectivity(connectivity type) -> ServiceConnectivity(@type value)\n
\nPacketNetworkAccessConnectivity(connectivity type) -> PacketNetworkAccessConnectivity(@type value)\n
\nPacketNetworkConnectivity(connectivity type) -> PacketNetworkConnectivity(@type value)\n \n",
"tags":[
"Resource/Connectivity"
],
"parameters":[
{
"required":true,
"name":"connectivityIdentifier",
"schema":{
"type":"string"
},
"in":"path",
"description":"The ID of the connectivity to be updated."
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/depth"
},
{
"$ref":"#/components/parameters/expand"
},
{
"name":"decryptAttributes",
"example":"ALL",
"schema":{
"type":"string"
},
"in":"query",
"description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is."
}
],
"requestBody":{
"description":"The connectivity to be updated.",
"required":true,
"content":{
"application/merge-patch+json":{
"schema":{
"$ref":"#/components/schemas/Connectivity"
}
},
"application/json-patch+json":{
"schema":{
"$ref":"#/components/schemas/PatchRequest"
}
}
}
},
"responses":{
"200":{
"description":"The connectivity was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Connectivity"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"connectivity-{connectivityIdentifier}-patch",
"x-filename-id":"connectivity-connectivityidentifier-patch"
},
"delete":{
"operationId":"deleteConnectivity",
"summary":"Delete a Connectivity",
"description":"Deletes the Connectivity that matches the specified connectivityIdentifier.\nNOTE: {connectivityIdentifier} in path parameter can be connectivityIdentifier or Id of the connectivity.\n",
"tags":[
"Resource/Connectivity"
],
"parameters":[
{
"required":true,
"name":"connectivityIdentifier",
"schema":{
"type":"string"
},
"in":"path",
"description":"The identifier of the connectivity to delete."
}
],
"responses":{
"204":{
"description":"The connectivity was deleted successfully."
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The connectivity wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"connectivity-{connectivityIdentifier}-delete",
"x-filename-id":"connectivity-connectivityidentifier-delete"
}
},
"/connectivity/{connectivityIdentifier}/{task}":{
"post":{
"operationId":"processConnectivity",
"summary":"Process a Connectivity",
"description":"This operation performs an action denoted by task on latest Connectivity design version of given connectivity Id (or identifier). \nSupported tasks are COMPLETE and CANCEL. These can be used to complete a design version or cancel it respectively.\nNOTE: {connectivityIdentifier} in path parameter can be connectivityIdentifier or Id of the connectivity.\nProcess a Connectivity Design version is an explicit operation for Connectivity resource. Hence, these task APIs are not supported on '/resource' URL.\n",
"tags":[
"Resource/Connectivity"
],
"parameters":[
{
"name":"connectivityIdentifier",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The connectivityIdentifier of the Connectivity to process."
},
{
"name":"task",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The task of the Connectivity to process. Possible tasks are COMPLETE and CANCEL."
},
{
"name":"decryptAttributes",
"example":"ALL",
"schema":{
"type":"string"
},
"in":"query",
"description":"Specifies which encrypted attributes to decrypt in the response use \"ALL\" to decrypt all attributes, provide a comma-separated list to decrypt specific attributes, or omit the parameter to return encrypted values as-is."
}
],
"responses":{
"200":{
"description":"The Connectivity was processed successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Connectivity"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The resources wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"connectivity-{connectivityIdentifier}-{task}-post",
"x-filename-id":"connectivity-connectivityidentifier-task-post"
}
},
"/rehome":{
"post":{
"operationId":"create rehome activity",
"summary":"Create a Rehome Activity",
"description":"Creates a Project with Rehome activity having specified rehome activity items.
\nOptionally, the project can be auto submitted by sending a query parameter 'submit=true'\n",
"tags":[
"Reconfigure Network Resources/Rehome"
],
"parameters":[
{
"required":false,
"name":"submit",
"schema":{
"type":"boolean"
},
"in":"query",
"description":"To submit the rehome project post creation."
}
],
"requestBody":{
"description":"The rehome project to be created",
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RehomeProject"
}
}
}
},
"responses":{
"201":{
"description":"The rehome project was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RehomeProject"
}
}
}
},
"202":{
"description":"The rehome project was created successfully and is auto submitted. Activity will be processed asynchronously.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RehomeProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"rehome-post",
"x-filename-id":"rehome-post"
}
},
"/rehome/{projectName}/{activityName}":{
"get":{
"operationId":"retrieveRehomeActivity",
"summary":"Get Rehome Activity by Name",
"description":"Gets the rehome activity details that matches the specified project and activity Name.\n",
"tags":[
"Reconfigure Network Resources/Rehome"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the project to get."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the activity to get."
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/depth"
},
{
"$ref":"#/components/parameters/expand"
}
],
"responses":{
"200":{
"description":"The rehome activity was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RehomeProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The rehome project wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"rehome-{projectName}-{activityName}-get",
"x-filename-id":"rehome-projectname-activityname-get"
},
"delete":{
"operationId":"deleteRehomeProject",
"summary":"Delete a Rehome Activity",
"description":"Deletes the rehome activity and the rehome Project that matches the specified name. If the specified Rehome project has multiple activities, only the specified activity will be deleted. \n",
"tags":[
"Reconfigure Network Resources/Rehome"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the rehome project to delete."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the rehome activity to delete."
}
],
"responses":{
"204":{
"description":"The rehome project activity was deleted successfully."
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The rehome project activity wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"rehome-{projectName}-{activityName}-delete",
"x-filename-id":"rehome-projectname-activityname-delete"
}
},
"/rehome/{projectName}/{activityName}/{task}":{
"post":{
"operationId":"processRehome",
"summary":"Process a Rehome Activity",
"description":"This operation processes a Rehome Activity. Possible tasks are VALIDATE, SUBMIT and CANCEL.",
"tags":[
"Reconfigure Network Resources/Rehome"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the rehome project to process."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the rehome activity to process."
},
{
"name":"task",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The action task to be performed on the rehome activity. Possible tasks are VALIDATE, SUBMIT and CANCEL."
}
],
"responses":{
"200":{
"description":"The rehome activity was processed successfully for VALIDATE or CANCEL Task. There is no response body for VALIDATE task. RehomeProject details is returned for CANCEL Task.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RehomeProject"
}
}
}
},
"202":{
"description":"The rehome activity was submitted successfully and the activity will be processed asynchronously.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RehomeProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The resources wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"rehome-{projectName}-{activityName}-{task}-post",
"x-filename-id":"rehome-projectname-activityname-task-post"
}
},
"/groom":{
"post":{
"operationId":"create groom activity",
"summary":"Create a Groom Activity",
"description":"Creates a Project with Groom activity having specified groom activity items.
\nOptionally, the project can be auto submitted by sending a query parameter 'submit=true'\n",
"tags":[
"Reconfigure Network Resources/Groom"
],
"parameters":[
{
"required":false,
"name":"submit",
"schema":{
"type":"boolean"
},
"in":"query",
"description":"To submit the groom project post creation."
}
],
"requestBody":{
"description":"The groom project to be created",
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GroomProject"
}
}
}
},
"responses":{
"201":{
"description":"The groom project was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GroomProject"
}
}
}
},
"202":{
"description":"The groom project was created successfully and is auto submitted. Activity will be processed asynchronously.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GroomProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"groom-post",
"x-filename-id":"groom-post"
}
},
"/groom/{projectName}/{activityName}":{
"get":{
"operationId":"retrieveGroomActivity",
"summary":"Get Groom Activity by Name",
"description":"Gets the groom activity details that matches the specified NAME.\n",
"tags":[
"Reconfigure Network Resources/Groom"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the groom project to get."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the activity to get."
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/depth"
},
{
"$ref":"#/components/parameters/expand"
}
],
"responses":{
"200":{
"description":"The groom activity was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GroomProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The logical device wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"groom-{projectName}-{activityName}-get",
"x-filename-id":"groom-projectname-activityname-get"
},
"delete":{
"operationId":"deleteGroomProject",
"summary":"Delete a Groom Project Activity",
"description":"Deletes the groom activity and the groom Project that matches the specified name. If the specified Groom project has multiple activities, only the specified activity will be deleted. \n",
"tags":[
"Reconfigure Network Resources/Groom"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the groom project activity to delete."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the groom project activity to delete."
}
],
"responses":{
"204":{
"description":"The groom project activity was deleted successfully."
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The groom project activity wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"groom-{projectName}-{activityName}-delete",
"x-filename-id":"groom-projectname-activityname-delete"
}
},
"/groom/{projectName}/{activityName}/{task}":{
"post":{
"operationId":"processGroom",
"summary":"Process a Groom Activity",
"description":"This operation processes a Groom Activity. Possible tasks are VALIDATE, SUBMIT and CANCEL.",
"tags":[
"Reconfigure Network Resources/Groom"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the groom project to process."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the activity to process."
},
{
"name":"task",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The task of the project to process. Possible tasks are VALIDATE, SUBMIT and CANCEL."
}
],
"responses":{
"200":{
"description":"The groom activity was processed successfully for VALIDATE or CANCEL Task. There is no response body for VALIDATE task. GroomProject details is returned for CANCEL Task.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GroomProject"
}
}
}
},
"202":{
"description":"The groom activity was submitted successfully and the activity will be processed asynchronously.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GroomProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The resources wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"groom-{projectName}-{activityName}-{task}-post",
"x-filename-id":"groom-projectname-activityname-task-post"
}
},
"/replacecard":{
"post":{
"operationId":"create replace card activity",
"summary":"Create a Replace Card Activity",
"description":"Creates a Project with Replace Card activity having specified replace card activity items.
\nOptionally, the project can be auto submitted by sending a query parameter 'submit=true'\n",
"tags":[
"Reconfigure Network Resources/ReplaceCard"
],
"parameters":[
{
"required":false,
"name":"submit",
"schema":{
"type":"boolean"
},
"in":"query",
"description":"To submit the replace card project post creation."
}
],
"requestBody":{
"description":"The replace card project to be created",
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ReplaceCardProject"
}
}
}
},
"responses":{
"201":{
"description":"The replace card project was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ReplaceCardProject"
}
}
}
},
"202":{
"description":"The replace card project was created successfully and is auto submitted. Activity will be processed asynchronously.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ReplaceCardProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"replacecard-post",
"x-filename-id":"replacecard-post"
}
},
"/replacecard/{projectName}/{activityName}":{
"get":{
"operationId":"retrieveReplaceCardActivity",
"summary":"Get Replace Card Activity by Name",
"description":"Gets the replace card activity details that matches the specified project and activity Name.\n",
"tags":[
"Reconfigure Network Resources/ReplaceCard"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the project to get."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the activity to get."
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/depth"
},
{
"$ref":"#/components/parameters/expand"
}
],
"responses":{
"200":{
"description":"The replace card activity was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ReplaceCardProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The replace card project wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"replacecard-{projectName}-{activityName}-get",
"x-filename-id":"replacecard-projectname-activityname-get"
},
"delete":{
"operationId":"deleteReplaceCardProject",
"summary":"Delete a Replace Card Activity",
"description":"Deletes the replace card activity and the replace card Project that matches the specified name. If the specified ReplaceCard project has multiple activities, only the specified activity will be deleted. \n",
"tags":[
"Reconfigure Network Resources/ReplaceCard"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the replace card project to delete."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the replace card activity to delete."
}
],
"responses":{
"204":{
"description":"The replace card project activity was deleted successfully."
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The ReplaceCard project activity wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"replacecard-{projectName}-{activityName}-delete",
"x-filename-id":"replacecard-projectname-activityname-delete"
}
},
"/replacecard/{projectName}/{activityName}/{task}":{
"post":{
"operationId":"processReplaceCard",
"summary":"Process a Replace Card Activity",
"description":"This operation processes a Replace Card Activity. Possible tasks are VALIDATE, SUBMIT and CANCEL.",
"tags":[
"Reconfigure Network Resources/ReplaceCard"
],
"parameters":[
{
"name":"projectName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the replace card project to process."
},
{
"name":"activityName",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The name of the replace card activity to process."
},
{
"name":"task",
"required":true,
"schema":{
"type":"string"
},
"in":"path",
"description":"The action task to be performed on the replace card activity. Possible tasks are VALIDATE, SUBMIT and CANCEL."
}
],
"responses":{
"200":{
"description":"The replace card activity was processed successfully for VALIDATE or CANCEL Task. No reponse body is returned for VALIDATE task. ReplaceCardProject details is retured for CANCEL Task.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ReplaceCardProject"
}
}
}
},
"202":{
"description":"The replace card activity was submitted successfully and the activity will be processed asynchronously.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ReplaceCardProject"
}
}
}
},
"400":{
"description":"The request isn't valid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"You aren't authorized to make this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"The request is forbidden.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The resources wasn't found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"An internal server error occurred.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
}
},
"x-internal-id":"replacecard-{projectName}-{activityName}-{task}-post",
"x-filename-id":"replacecard-projectname-activityname-task-post"
}
},
"/paths/pipe/{id}":{
"get":{
"operationId":"retrieveAllPathsOfPipe",
"summary":"Get Enabling Paths of Pipe by ID",
"description":"Gets the enabling paths of pipe that matches the specified ID.
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Retrieve Paths/Pipe" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The ID of the pipe to get." } ], "responses":{ "200":{ "description":"The pipe was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Path" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Paths are not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"paths-pipe-{id}-get", "x-filename-id":"paths-pipe-id-get" } }, "/paths/connectivity/{id}":{ "get":{ "operationId":"retrieveAllPathsOfConnectivity", "summary":"Get Enabling Paths of Connectivity by ID", "description":"Gets enabling paths of connectivity that matches the specified or id. \n
Attribute selection is enabled for all first-level attributes.
\nOptionally, use the expand parameter to specify resource relationship (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.
\nOptionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.\n
\n", "tags":[ "Retrieve Paths/Connectivity" ], "parameters":[ { "required":true, "name":"id", "schema":{ "type":"string" }, "in":"path", "description":"The id of the connectivity to get." } ], "responses":{ "200":{ "description":"The connectivity was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Path" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The Connectivity wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"paths-connectivity-{id}-get", "x-filename-id":"paths-connectivity-id-get" } }, "/resourceReservation/{reservationNumber}/reserveResource":{ "post":{ "tags":[ "Resource Reservation" ], "summary":"Reserve a Resource to a Reservation Number", "description":"This operation reserves a resource to the given reservation number", "parameters":[ { "name":"reservationNumber", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The reservationNumber to add the resource" } ], "operationId":"createResourceReservation", "requestBody":{ "description":"The Resource Reservation to be created", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityResourceReservation" } } } }, "responses":{ "200":{ "description":"Resource reservation got created successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityResourceReservation" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resourceReservation-{reservationNumber}-reserveResource-post", "x-filename-id":"resourcereservation-reservationnumber-reserveresource-post" } }, "/resourceReservation/unreserveResources":{ "post":{ "tags":[ "Resource Reservation" ], "summary":"Unreserve Resources", "description":"Unreserves reservation for given resources", "operationId":"deleteResourceReservationList", "requestBody":{ "$ref":"#/components/requestBodies/ResourceReservationItemArray", "required":true }, "responses":{ "204":{ "description":"The resource reservations were deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resourceReservation-unreserveResources-post", "x-filename-id":"resourcereservation-unreserveresources-post" } }, "/resourceReservation/{reservationNumber}":{ "get":{ "tags":[ "Resource Reservation" ], "summary":"Get Reservations by Reservation Number", "parameters":[ { "name":"reservationNumber", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The reservationNumber of reservation to get" } ], "description":"Gets all the reservation that matches the specified ReservationNumber", "operationId":"retrieveResourceReservation", "responses":{ "200":{ "description":"Resource reservations retrieved successfully", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntityResourceReservation" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resourceReservation-{reservationNumber}-get", "x-filename-id":"resourcereservation-reservationnumber-get" }, "delete":{ "tags":[ "Resource Reservation" ], "summary":"Unreserve Reservations by Reservation Number", "parameters":[ { "name":"reservationNumber", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The reservationNumber of reservation to delete" } ], "description":"Unreserves all the reservation that matches the specified ReservationNumber", "operationId":"deleteResourceReservation", "responses":{ "204":{ "description":"The resource reservation was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resourceReservation-{reservationNumber}-delete", "x-filename-id":"resourcereservation-reservationnumber-delete" }, "patch":{ "tags":[ "Resource Reservation" ], "summary":"Update a Reservation", "parameters":[ { "name":"reservationNumber", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The reservationNumber of reservation to update" } ], "description":"Updates reservation for a given resource", "operationId":"patchResourceReservation", "requestBody":{ "description":"The Resource Reservation to be updated", "required":true, "content":{ "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/EntityResourceReservation" } } } }, "responses":{ "200":{ "description":"Resource reservation got updated successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityResourceReservation" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resourceReservation-{reservationNumber}-patch", "x-filename-id":"resourcereservation-reservationnumber-patch" } }, "/resourceReservation/resource/id/{id}":{ "get":{ "tags":[ "Resource Reservation" ], "summary":"Get Reservation by ID", "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"ID of the resource item with business identifier" } ], "description":"Gets Reservation of the given id", "operationId":"getResourceReservation", "responses":{ "200":{ "description":"Resource reservations retrieved successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityResourceReservation" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resourceReservation-resource-id-{id}-get", "x-filename-id":"resourcereservation-resource-id-id-get" } }, "/resourceReservation":{ "post":{ "tags":[ "Resource Reservation" ], "summary":"Reserve Resources under a single Reservation Number", "description":"Reserves all the resources under a single reservation number.", "operationId":"createResourceReservations", "requestBody":{ "$ref":"#/components/requestBodies/ResourceReservation", "required":true }, "responses":{ "201":{ "description":"Resource reservations created successfully", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntityResourceReservation" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources wasn't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"resourceReservation-post", "x-filename-id":"resourcereservation-post" } }, "/impactAnalysis/equipmentImpacts/{id}":{ "get":{ "operationId":"getEquipmentImpacts", "summary":"Get Impacted Components for the Equipment Resource outage.", "description":"Retrieves a list of impacted components associated with the specified equipment resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Equipment to fetch the impacts of Equipment outage." } ], "responses":{ "200":{ "description":"The outage impacts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EquipmentOutageImpacts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-equipmentImpacts-{id}-get", "x-filename-id":"impactanalysis-equipmentimpacts-id-get" } }, "/impactAnalysis/equipmentImpactsCounts/{id}":{ "get":{ "operationId":"getEquipmentImpactsCounts", "summary":"Get Impacted Components Count for the Equipment Resource outage.", "description":"Retrieves the count of impacted components associated with the specified equipment resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Equipment to fetch the impacts count of Equipment outage." } ], "responses":{ "200":{ "description":"The outage impacts counts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutageImpactEntitiyCounts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-equipmentImpactsCounts-{id}-get", "x-filename-id":"impactanalysis-equipmentimpactscounts-id-get" } }, "/impactAnalysis/physicalPortImpacts/{id}":{ "get":{ "operationId":"getPhysicalPortImpacts", "summary":"Get Impacted Components for the Physical Port Resource outage.", "description":"Retrieves a list of impacted components associated with the specified physical port resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Physical Port to fetch the impacts of Physical Port outage." } ], "responses":{ "200":{ "description":"The outage impacts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalPortOutageImpacts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-physicalPortImpacts-{id}-get", "x-filename-id":"impactanalysis-physicalportimpacts-id-get" } }, "/impactAnalysis/physicalPortImpactsCounts/{id}":{ "get":{ "operationId":"getPhysicalPortImpactsCounts", "summary":"Get Impacted Components Count for the Physical Port Resource outage.", "description":"Retrieves the count of impacted components associated with the specified physical port resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Physical Port to fetch the impacts count of Physical Port outage." } ], "responses":{ "200":{ "description":"The outage impacts counts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutageImpactEntitiyCounts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-physicalPortImpactsCounts-{id}-get", "x-filename-id":"impactanalysis-physicalportimpactscounts-id-get" } }, "/impactAnalysis/deviceInterfaceImpacts/{id}":{ "get":{ "operationId":"getDeviceInterfaceImpacts", "summary":"Get Impacted Components for the Device Interface Resource outage.", "description":"Retrieves a list of impacted components associated with the specified device interface resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Device Interface to fetch the impacts of Device Interface outage." } ], "responses":{ "200":{ "description":"The outage impacts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeviceInterfaceOutageImpacts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-deviceInterfaceImpacts-{id}-get", "x-filename-id":"impactanalysis-deviceinterfaceimpacts-id-get" } }, "/impactAnalysis/deviceInterfaceImpactsCounts/{id}":{ "get":{ "operationId":"getDeviceInterfaceImpactsCounts", "summary":"Get Impacted Components Count for the Device Interface Resource outage.", "description":"Retrieves the count of impacted components associated with the specified device interface resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Device Interface to fetch the impacts count of Device Interface outage." } ], "responses":{ "200":{ "description":"The outage impacts counts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutageImpactEntitiyCounts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-deviceInterfaceImpactsCounts-{id}-get", "x-filename-id":"impactanalysis-deviceinterfaceimpactscounts-id-get" } }, "/impactAnalysis/logicalDeviceImpacts/{id}":{ "get":{ "operationId":"getLogicalDeviceImpacts", "summary":"Get Impacted Components for the Logical Device Resource outage.", "description":"Retrieves a list of impacted components associated with the specified logical device resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Logical Device to fetch the impacts of Logical Device outage." } ], "responses":{ "200":{ "description":"The outage impacts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/LogicalDeviceOutageImpacts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-logicalDeviceImpacts-{id}-get", "x-filename-id":"impactanalysis-logicaldeviceimpacts-id-get" } }, "/impactAnalysis/logicalDeviceImpactsCounts/{id}":{ "get":{ "operationId":"getLogicalDeviceImpactsCounts", "summary":"Get Impacted Components Count for the Logical Device Resource outage.", "description":"Retrieves the count of impacted components associated with the specified logical device resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Logical Device to fetch the impacts count of Logical Device outage." } ], "responses":{ "200":{ "description":"The outage impacts counts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutageImpactEntitiyCounts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-logicalDeviceImpactsCounts-{id}-get", "x-filename-id":"impactanalysis-logicaldeviceimpactscounts-id-get" } }, "/impactAnalysis/physicalDeviceImpacts/{id}":{ "get":{ "operationId":"getPhysicalDeviceImpacts", "summary":"Get Impacted Components for the Physical Device Resource outage.", "description":"Retrieves a list of impacted components associated with the specified logical device resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Physical Device to fetch the impacts of Physical Device outage." } ], "responses":{ "200":{ "description":"The outage impacts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PhysicalDeviceOutageImpacts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-physicalDeviceImpacts-{id}-get", "x-filename-id":"impactanalysis-physicaldeviceimpacts-id-get" } }, "/impactAnalysis/physicalDeviceImpactsCounts/{id}":{ "get":{ "operationId":"getPhysicalDeviceImpactsCounts", "summary":"Get Impacted Components Count for the Physical Device Resource outage.", "description":"Retrieves the count of impacted components associated with the specified physical device resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Physical Device to fetch the impacts count of Physical Device outage." } ], "responses":{ "200":{ "description":"The outage impacts counts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutageImpactEntitiyCounts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-physicalDeviceImpactsCounts-{id}-get", "x-filename-id":"impactanalysis-physicaldeviceimpactscounts-id-get" } }, "/impactAnalysis/connectivityImpacts/{id}":{ "get":{ "operationId":"getConnectivityImpacts", "summary":"Get Impacted Components for the Pipe/Connectivity Resource outage.", "description":"Retrieves a list of impacted components associated with the specified pipe or connectivity resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Pipe/Connectivity to fetch the impacts of Pipe/Connectivity outage." } ], "responses":{ "200":{ "description":"The outage impacts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectivityOutageImpacts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-connectivityImpacts-{id}-get", "x-filename-id":"impactanalysis-connectivityimpacts-id-get" } }, "/impactAnalysis/connectivityImpactsCounts/{id}":{ "get":{ "operationId":"getConnectivityImpactsCounts", "summary":"Get Impacted Components Count for the Pipe/Connectivity Resource outage.", "description":"Retrieves the count of impacted components associated with the specified pipe or connectivity resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Connectivity/Pipe to fetch the impacts count of Connectivity/Pipe outage." } ], "responses":{ "200":{ "description":"The outage impacts counts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutageImpactEntitiyCounts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-connectivityImpactsCounts-{id}-get", "x-filename-id":"impactanalysis-connectivityimpactscounts-id-get" } }, "/impactAnalysis/placeImpacts/{id}":{ "get":{ "operationId":"getPlaceImpacts", "summary":"Get Impacted Components for the Geographic Place Resource outage.", "description":"Retrieves a list of impacted components associated with the specified geographic place resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Geographic Place to fetch the impacts of Geographic Place outage." } ], "responses":{ "200":{ "description":"The outage impacts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GeographicPlaceOutageImpacts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-placeImpacts-{id}-get", "x-filename-id":"impactanalysis-placeimpacts-id-get" } }, "/impactAnalysis/placeImpactsCounts/{id}":{ "get":{ "operationId":"getPlaceImpactsCounts", "summary":"Get Impacted Components Count for the Geographic Place Resource outage.", "description":"Retrieves the count of impacted components associated with the specified geographic place resource outage.", "tags":[ "Impact Analysis" ], "parameters":[ { "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The ID of the Geographic Place to fetch the impacts count of Geographic Place outage." } ], "responses":{ "200":{ "description":"The outage impacts counts were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutageImpactEntitiyCounts" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"impactAnalysis-placeImpactsCounts-{id}-get", "x-filename-id":"impactanalysis-placeimpactscounts-id-get" } }, "/subNodeInfo":{ "get":{ "operationId":"getSubNodeInformation", "summary":"Get the subnode information.", "description":"Get the subnode information and Connectivity / Pipe entities terminated on it. Subnode is the UIM entity such as DeviceInterface, PhysicalConnector, PhysicalPort or Equipment. Whereas node represents the entity which encapsulates or is parent of the subnode such as PhysicalDevice, Equipment or LogicalDevice. Connections are the Connectivity / Pipe instances which are terminated on the looked up subnode and all of its children entities (if any).", "tags":[ "Impact Analysis/Subnode Information" ], "parameters":[ { "name":"connections", "required":false, "description":"Defines if the connections information should be included in response or not.", "schema":{ "type":"boolean" }, "in":"query" } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NodeLookupRequest" } } } }, "responses":{ "200":{ "description":"The node and subnode information were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/NodeLookupResponse" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resources (either node or subnode) weren't found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"subNodeInfo-get", "x-filename-id":"subnodeinfo-get" } }, "/subNodeInfo/connections":{ "get":{ "operationId":"getConnections", "summary":"Get the Connectivity / Pipe entities terminated on resource.", "description":"Get the Connectivity / Pipe entities terminated on given the resource.", "tags":[ "Impact Analysis/Subnode Information" ], "parameters":[ { "name":"resourceType", "required":true, "description":"Type of the resource.", "schema":{ "type":"string", "enum":[ "PhysicalDevice", "Equipment", "PhysicalPort", "DeviceInterface", "PhysicalConnector" ] }, "in":"query" }, { "name":"resourceId", "required":true, "description":"Id of the resource.", "schema":{ "type":"string" }, "in":"query" } ], "responses":{ "200":{ "description":"The connections information was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ConnectionsInfoResponse" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"You aren't authorized to make this request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource was not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"An internal server error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"subNodeInfo-connections-get", "x-filename-id":"subnodeinfo-connections-get" } } }, "components":{ "schemas":{ "EntityClassEnum":{ "type":"string", "description":"The list of valid values for an entity class.", "enum":[ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ] }, "ResourceTypeEnum":{ "description":"The list of valid values for the resource type.", "type":"string", "enum":[ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe", "PipeTerminationPoint", "Connectivity" ] }, "InventoryStateEnum":{ "type":"string", "description":"The list of valid values for inventory state.", "enum":[ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED", "IN_DESIGN" ] }, "RelationshipTypeEnum":{ "type":"string", "description":"The list of valid values for relationship type.", "enum":[ "ASSOCIATES", "MAPPEDTO", "PARENT", "CHILD", "INVOLVE", "ASSIGN", "CONSUMER" ] }, "ConfigurationStateEnum":{ "type":"string", "description":"The list of valid values for configuration state.", "enum":[ "IN_PROGRESS", "DESIGNED", "ISSUED", "COMPLETED", "PENDING_CANCEL", "CANCELLED" ] }, "AssignmentStateEnum":{ "type":"string", "description":"The list of valid values for assignment state.", "enum":[ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ] }, "ReferenceStateEnum":{ "type":"string", "description":"The list of valid values for reference state.", "enum":[ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ] }, "PlaceReferredTypeEnum":{ "type":"string", "description":"The list of valid values for place referred type.", "enum":[ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ] }, "ResourceStatusType":{ "type":"string", "description":"The list of valid values for resource status type, which indicates if entity has reservations.", "enum":[ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ] }, "Characteristic":{ "type":"object", "description":"A characteristic of an object or entity represented by a name-value pair.", "required":[ "name", "value" ], "properties":{ "name":{ "type":"string", "description":"The name of the characteristic." }, "displayName":{ "type":"string", "description":"The display label of the charatcteristic." }, "valueType":{ "type":"string", "description":"The data type for the characteristics's value.", "enum":[ "ALPHANUMERIC", "NUMERIC", "BOOLEAN", "DATE", "OBJECT", "URL" ] }, "code":{ "type":"string", "description":"The enumeration code in case of enum type characteristics." }, "value":{ "type":"object", "description":"The value of the characteristic." }, "@schemaLocation":{ "type":"string", "description":"The URI for the JSON Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the valueType is an object." } } }, "Specification":{ "type":"object", "description":"A specification.", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The ID of the specification, which is the same as the name of the specification." }, "href":{ "type":"string", "format":"uri", "description":"The URI for the specification." }, "name":{ "type":"string", "description":"The name of the specification." }, "displayName":{ "type":"string", "description":"The display name of the specification." }, "description":{ "type":"string", "description":"Details about the specification." }, "version":{ "type":"string", "description":"The version of the specification, which is always 1." }, "entityType":{ "$ref":"#/components/schemas/EntityClassEnum" }, "startDate":{ "type":"string", "format":"date-time", "description":"The date and time when the specification starts." }, "endDate":{ "type":"string", "format":"date-time", "description":"The date and time when the specification ends." }, "autoGenId":{ "type":"boolean", "description":"The boolean value to indicate if id has to be auto-generated or entered manually by user." }, "characteristics":{ "type":"array", "description":"List of characteristics including hard attributes defined for the specification. Currently characteristics will be displayed only for Network/Pipe/PL/LD/PD/Equipment required for NPD. Only available hard attributes as per design studio layout are displayed.", "items":{ "$ref":"#/components/schemas/CharacteristicSpecification" } }, "pageEditLayout":{ "$ref":"#/components/schemas/PageLayout" } } }, "PageLayout":{ "type":"object", "description":"Layout information for Create and Edit Pages", "properties":{ "pageName":{ "type":"string", "description":"Name of the panel chosed in Layout" }, "sections":{ "$ref":"#/components/schemas/SectionLayoutArr" } } }, "SectionLayoutArr":{ "type":"array", "items":{ "$ref":"#/components/schemas/SectionLayout" } }, "SectionLayout":{ "type":"object", "properties":{ "sectionName":{ "type":"string", "description":"The localized name of the section." }, "sectionTooltip":{ "type":"string", "description":"The localized tool tip of the section." }, "localizedSectionNames":{ "type":"array", "description":"The localized name of the section. This is for internal usage.", "items":{ "$ref":"#/components/schemas/LocalizedSpec" } }, "localizedSectionToolTip":{ "type":"array", "description":"Localized Tool Tip of the section. This is for internal usage.", "items":{ "$ref":"#/components/schemas/LocalizedSpec" } }, "elements":{ "type":"array", "description":"The elements of the section.", "items":{ "$ref":"#/components/schemas/RowLayoutArr" } } } }, "RowLayoutArr":{ "type":"array", "items":{ "$ref":"#/components/schemas/ComponentSpecification" } }, "ComponentSpecification":{ "type":"object", "properties":{ "elementName":{ "type":"string", "description":"The name of the hard attribute or char name." }, "isHardAttribute":{ "type":"boolean", "description":"Indicates if element is hard attribute or not." }, "displayName":{ "type":"string", "description":"The localized display name of the element." }, "tooltip":{ "type":"string", "description":"The localized tooltip of the element." }, "localizedDisplayNames":{ "type":"array", "description":"The localized display names of the element. This is for internal usage.", "items":{ "$ref":"#/components/schemas/LocalizedSpec" } }, "localizedToolTips":{ "type":"array", "description":"The localized tool tips of the element. This is for internal usage.", "items":{ "$ref":"#/components/schemas/LocalizedSpec" } }, "isRequired":{ "type":"boolean", "description":"Indicates if element is required." }, "isSensitive":{ "type":"boolean", "description":"Indicates if element has to be hidden." }, "isExternal":{ "type":"boolean", "description":"Applicable only for URL Chars. Indicates if URL to be opened in new tab." }, "isReadOnly":{ "type":"boolean", "description":"Indicates if element is read only." }, "displayMask":{ "type":"string", "description":"The displayMask of the element." }, "editMask":{ "type":"string", "description":"The editMask of the element." }, "case":{ "type":"string", "description":"The case of the element. Possible values are MIXED,UPPER,LOWER." }, "toDateRange":{ "type":"string", "description":"The start date Range of the element for Date Chars." }, "fromDateRange":{ "type":"string", "description":"The end date Range of the element for Date Chars." }, "minValue":{ "type":"string", "description":"The minimum value of the element." }, "maxValue":{ "type":"string", "description":"The maximum value of the element." }, "sort":{ "type":"string", "description":"Applicable only for Enum chars.", "enum":[ "ALPHANUMERIC", "NUMERIC" ] }, "defaultValue":{ "type":"string", "description":"The default Value of the element." } } }, "ControlTypeEnum":{ "description":"The list of valid values for the control type.", "type":"string", "enum":[ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ] }, "LocalizedSpec":{ "type":"object", "properties":{ "value":{ "type":"string", "description":"Value of the element." }, "language":{ "type":"string", "description":"Language of the element." } } }, "CharacteristicSpecification":{ "type":"object", "description":"A characteristic of an object or entity represented by a name-value pair.", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"The name of the characteristic." }, "isHardAttribute":{ "type":"boolean" }, "primitiveType":{ "type":"string", "description":"The data type for the characteristics's value.", "enum":[ "BOOLEAN", "DATE", "DATETIME", "DECIMAL", "DOUBLE", "FLOAT", "HEXBINARY", "INTEGER", "LONG", "STRING", "TIME" ] }, "displayName":{ "type":"string", "description":"The display name of the characteristic." }, "controlType":{ "oneOf":[ { "$ref":"#/components/schemas/DropDownCharSpec" }, { "$ref":"#/components/schemas/TextCharSpec" }, { "$ref":"#/components/schemas/URLCharSpec" }, { "$ref":"#/components/schemas/CalendarCharSpec" }, { "$ref":"#/components/schemas/NumericCharSpec" }, { "$ref":"#/components/schemas/CheckboxCharSpec" } ] }, "isRequired":{ "type":"boolean", "description":"The requirement of the element" }, "valueChangeListener":{ "type":"boolean", "description":"Indicates if it is parent char and there are dependent chars when value is enterted for this char." } } }, "DropDownCharSpec":{ "type":"object", "description":"List of attributes applicable only if Characteristic is of type dropdown.", "properties":{ "@type":{ "$ref":"#/components/schemas/ControlTypeEnum" }, "options":{ "type":"string", "description":"The dropdown option for the element.", "enum":[ "ENUMERATIONS", "ENTITYLINK", "QUERY" ] }, "sort":{ "type":"string", "description":"The sorting order of the enumeration options.", "enum":[ "ALPHANUMERIC", "NUMERIC" ] }, "enumerationOptions":{ "type":"array", "description":"The list of options.", "items":{ "$ref":"#/components/schemas/Enumerations" } }, "defaultValue":{ "type":"string", "description":"The default value from the enumeration options." } } }, "Enumerations":{ "type":"object", "properties":{ "code":{ "type":"string", "description":"Key for the enum element." }, "description":{ "type":"string", "description":"Description for the enum element." }, "default":{ "type":"boolean", "description":"Indicates if the code is default selected attribute in dropdown." }, "language":{ "type":"string", "description":"The language of the element." } } }, "TextCharSpec":{ "type":"object", "description":"List of attributes applicable only if Characteristic is of control type text.", "properties":{ "@type":{ "$ref":"#/components/schemas/ControlTypeEnum" }, "isSensitive":{ "type":"boolean", "description":"Indicates if element is to be hidden." }, "isReadOnly":{ "type":"boolean", "description":"Indicates if element is read only." }, "displayMask":{ "type":"string", "description":"The displayMask of the characteristic." }, "editMask":{ "type":"string", "description":"The editMask of the characteristic." }, "case":{ "type":"string", "description":"The case of the characteristic.", "enum":[ "MIXED", "UPPER", "LOWER" ] }, "minLength":{ "type":"integer", "description":"The minimum length of the characteristic." }, "maxLength":{ "type":"integer", "description":"The maximum length of the characteristic." }, "defaultValue":{ "type":"string", "description":"The default value of the characteristic." }, "defaultValueLocalized":{ "type":"string", "description":"The localized default value of the characteristic." } } }, "URLCharSpec":{ "type":"object", "description":"List of attributes applicable only if Characteristic is of control type URL.", "properties":{ "@type":{ "$ref":"#/components/schemas/ControlTypeEnum" }, "isReadOnly":{ "type":"boolean", "description":"The readOnly of the URL char" }, "defaultValue":{ "type":"string", "description":"The default value of the URL char" } } }, "CalendarCharSpec":{ "type":"object", "description":"List of attributes applicable only if Characteristic is of control type Calendar.", "properties":{ "@type":{ "$ref":"#/components/schemas/ControlTypeEnum" }, "isReadOnly":{ "type":"boolean", "description":"The readOnly of the Calendar char." }, "toDateRange":{ "type":"string", "description":"The start date range of the Calendar char." }, "fromDateRange":{ "type":"string", "description":"The end date range of the Calendar char." }, "defaultValue":{ "type":"string", "description":"The default value of the Calendar char." } } }, "NumericCharSpec":{ "type":"object", "description":"List of attributes applicable only if Characteristic is of control type Numeric.", "properties":{ "@type":{ "$ref":"#/components/schemas/ControlTypeEnum" }, "isSensitive":{ "type":"boolean", "description":"The sensitive of the Numeric char." }, "isReadOnly":{ "type":"boolean", "description":"The readOnly of the Numeric char." }, "displayMask":{ "type":"string", "description":"The display mask of the Numeric char." }, "editMask":{ "type":"string", "description":"The edit mask of the Numeric char." }, "minValue":{ "type":"integer", "description":"The minimum value of the Numeric char." }, "maxValue":{ "type":"integer", "description":"The maximum value of the Numeric char." }, "defaultValue":{ "type":"integer", "description":"The default value of the Numeric char." } } }, "CheckboxCharSpec":{ "type":"object", "description":"List of attributes applicable only if Characteristic is of control type Checkbox.", "properties":{ "@type":{ "$ref":"#/components/schemas/ControlTypeEnum" }, "isReadOnly":{ "type":"boolean", "description":"The readOnly of the Checkbox char." }, "defaultValue":{ "type":"boolean", "description":"The default value of the Checkbox char." } } }, "ConnectivitySpecification":{ "allOf":[ { "$ref":"#/components/schemas/Specification" }, { "type":"object", "properties":{ "connClassification":{ "type":"string", "enum":[ "PACKET", "MULTIPLEXED", "SERVICE" ] }, "instanceType":{ "type":"string", "enum":[ "EthernetUNIConnectivity", "EthernetINNIConnectivity", "EthernetENNIConnectivity", "PacketNetworkAccessConnectivity", "PacketNetworkConnectivity", "MultiplexedConnectivity", "ServiceConnectivity" ] } } } ] }, "PlaceRef":{ "type":"object", "description":"A place to associate with the resource/service.", "required":[ "id", "@referredType" ], "properties":{ "id":{ "type":"string", "description":"The ID of the place." }, "href":{ "type":"string", "format":"uri", "description":"The URI for the place." }, "name":{ "type":"string", "description":"The name of the place." }, "@referredType":{ "$ref":"#/components/schemas/PlaceReferredTypeEnum" }, "role":{ "type":"string", "description":"The role of the place." }, "referrerRole":{ "type":"string", "description":"The role of the associated resource." } } }, "RelatedPartyRef":{ "type":"object", "description":"A related party, which defines a party or party role linked to a specific entity.", "required":[ "id", "@referredType" ], "properties":{ "id":{ "type":"string", "description":"The ID of the related party." }, "href":{ "type":"string", "format":"uri", "description":"The URI for the related party." }, "name":{ "type":"string", "description":"The name of the related party." }, "role":{ "type":"string", "description":"The role of the related party." }, "@referredType":{ "type":"string", "description":"Concrete Type of the Party, in case of dis-ambiguity. Default is 'Party'." } } }, "ResourceRef":{ "type":"object", "required":[ "id", "@referredType" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier of the supporting resource." }, "href":{ "type":"string", "description":"Reference of the supporting resource.", "readOnly":true }, "name":{ "type":"string", "description":"Name of the resource supporting the service." }, "@referredType":{ "$ref":"#/components/schemas/ResourceTypeEnum" } } }, "ExternalIdentity":{ "type":"object", "description":"An external identity.", "properties":{ "externalObjectId":{ "type":"string", "description":"The ID for a business entity." }, "externalName":{ "type":"string", "description":"The business-meaningful name of the business entity." }, "externalManagementDomain":{ "type":"string", "description":"The external system, domain name, party, or participant in a federation solution." }, "externalArrangement":{ "type":"string", "description":"The type of federation model between UIM and the external party for the given entity.", "enum":[ "LEASED_IN", "FEDERATED", "LEASED_OUT", "SHARED" ] } } }, "Role":{ "type":"object", "description":"A role.", "properties":{ "roleName":{ "type":"string", "description":"The name of the role." }, "roleType":{ "type":"string", "description":"The type of role.", "enum":[ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ] } } }, "TimePeriod":{ "type":"object", "description":"A time period.", "properties":{ "startDate":{ "type":"string", "description":"The date and time when the time period starts.", "format":"date-time" }, "endDate":{ "type":"string", "description":"The date and time when the time period ends.", "format":"date-time" } } }, "Error":{ "type":"object", "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).", "properties":{ "code":{ "type":"string", "description":"The error code." }, "reason":{ "type":"string", "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem." }, "message":{ "type":"array", "description":"The text that provides more details about the error as well as corrective actions.", "items":{ "type":"string" } }, "status":{ "type":"string", "description":"The HTTP error code extension, such as 400-2." }, "referenceError":{ "type":"string", "description":"The URL pointing to the documentation that describes the error." }, "entityType":{ "$ref":"#/components/schemas/EntityClassEnum" } } }, "ResourceBaseTypeEnum":{ "description":"The list of valid values for the type of base resource.", "type":"string", "readOnly":true, "enum":[ "PhysicalResource", "LogicalResource" ] }, "MacAddressTypeEnum":{ "description":"The list of valid values for the type of MAC address.", "type":"string", "enum":[ "ETHERNET", "ATM", "BLUETOOTH", "FIBRE_CHANNEL", "MAC_TYPE_80211" ] }, "IPv6AddressTypeEnum":{ "description":"The list of valid values for the type of IPv6 address.", "type":"string", "enum":[ "GLOBAL_UNICAST", "UNIQUE_LOCAL_UNICAST" ] }, "VersionTypeEnum":{ "description":"The list of valid values for the type of network version.", "type":"string", "enum":[ "IPV4", "IPV6" ] }, "ResourceBase":{ "type":"object", "description":"A base resource Class.", "discriminator":{ "propertyName":"@type" }, "properties":{ "id":{ "type":"string", "description":"The ID of the resource." }, "href":{ "type":"string", "description":"The URI for the resource class.", "format":"uri", "readOnly":true }, "@type":{ "$ref":"#/components/schemas/ResourceTypeEnum" }, "@baseType":{ "$ref":"#/components/schemas/ResourceBaseTypeEnum" }, "name":{ "type":"string", "description":"The name of the resource." }, "description":{ "type":"string", "description":"A free-text description for the resource." }, "resourceVersion":{ "type":"string", "description":"A field that identifies the version of a resource instance.", "readOnly":true }, "lifecycleState":{ "$ref":"#/components/schemas/InventoryStateEnum" }, "lifecycleSubState":{ "$ref":"#/components/schemas/AssignmentStateEnum", "readOnly":true }, "resourceStatus":{ "$ref":"#/components/schemas/ResourceStatusType", "readOnly":true }, "category":{ "type":"string", "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource." }, "startOperatingDate":{ "type":"string", "format":"date-time", "description":"The starting date and time when the resource becomes effective.", "readOnly":true }, "endOperatingDate":{ "type":"string", "format":"date-time", "description":"The date and time when the resource is no longer effective." }, "resourceRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceRelationship" }, "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc." }, "resourceCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" }, "description":"The list of characteristics for the resource." }, "resourceSpecification":{ "$ref":"#/components/schemas/Specification" }, "place":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlaceRef" }, "description":"The list of associated geographic places." }, "externalIdentity":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/ExternalIdentity" } ], "description":"The external identity details for the federated resource.", "readOnly":true } } }, "LogicalResource":{ "type":"object", "description":"The base class for logical resources.", "allOf":[ { "$ref":"#/components/schemas/ResourceBase" }, { "type":"object" } ] }, "PhysicalResource":{ "type":"object", "description":"The base class for physical resources.", "allOf":[ { "$ref":"#/components/schemas/ResourceBase" }, { "type":"object", "properties":{ "serialNumber":{ "type":"string", "description":"The serial number for the physical resource." } } } ] }, "ResourceRelationship":{ "type":"object", "description":"A relationship to a resource.", "properties":{ "relationshipType":{ "$ref":"#/components/schemas/RelationshipTypeEnum" }, "resourceRef":{ "$ref":"#/components/schemas/ResourceBase" }, "fromRole":{ "type":"string", "description":"The role name for the from-resource. Applies only to INVOLVE relationship types." }, "toRole":{ "type":"string", "description":"The role name for the to-resource. Applies only to INVOLVE relationship types." } } }, "LogicalDevice":{ "description":"A logical device.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "vendorName":{ "type":"string", "description":"The vendor name for the logical device." }, "modelNumber":{ "type":"string", "description":"The model number for the logical device." }, "partNumber":{ "type":"string", "description":"The part number for the logical device." }, "networkLocation":{ "$ref":"#/components/schemas/PlaceRef" }, "serviceLocation":{ "$ref":"#/components/schemas/PlaceRef" }, "deviceIdentifier":{ "type":"string", "description":"The name of the device identifier." }, "capacityConsumed":{ "type":"string", "description":"The capacity of the logical device consumed." }, "totalCapacity":{ "type":"string", "description":"Total capacity of the logical device." }, "percentageConsumed":{ "type":"string", "description":"Percentage of the logical device's capacity consumed." }, "deviceInterfaces":{ "type":"string", "format":"uri", "description":"The URI for the list of device interfaces for the logical device." }, "childDeviceInterfaces":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceInterface" } }, "logicalDeviceAccounts":{ "type":"string", "format":"uri", "description":"The URI for the list of logical device accounts associated with the logical device." }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" }, "description":"The list of logical device roles." } } } ] }, "DeviceInterface":{ "description":"A device interface.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "rateCode":{ "type":"string", "description":"The technology and transmission bit rate supported by the interface.", "readOnly":true }, "bitRate":{ "type":"string", "description":"The bitrate speed of transmission identified by the rate code.", "readOnly":true }, "interfaceNumber":{ "type":"string", "description":"A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values." }, "customerInterfaceNumber":{ "type":"string", "description":"The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer." }, "vendorInterfaceNumber":{ "type":"string" }, "logicalDeviceRef":{ "$ref":"#/components/schemas/LogicalDevice" }, "parentDeviceInterfaceRef":{ "$ref":"#/components/schemas/DeviceInterface" }, "childDeviceInterfaces":{ "type":"array", "items":{ "$ref":"#/components/schemas/DeviceInterface" } }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" }, "description":"The list of device interface roles." } } } ] }, "PhysicalDevice":{ "description":"A physical device resource.", "allOf":[ { "$ref":"#/components/schemas/PhysicalResource" }, { "type":"object", "properties":{ "networkLocation":{ "$ref":"#/components/schemas/PlaceRef" }, "physicalAddress":{ "type":"string", "description":"The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address." }, "physicalLocation":{ "type":"string", "description":"The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System)." }, "physicalConnectors":{ "type":"string", "format":"uri", "description":"The URI for the list of physical connector instances provided by the physical device instance.", "readOnly":true }, "physicalPorts":{ "type":"string", "format":"uri", "description":"The URI for the list of physical ports provided by the physical device instance.", "readOnly":true }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" }, "description":"The list of physical device inventory roles." } } } ] }, "PhysicalPort":{ "description":"A physical port.", "allOf":[ { "$ref":"#/components/schemas/PhysicalResource" }, { "type":"object", "properties":{ "portNumber":{ "type":"integer", "description":"A non-zero integer that uniquely identifies this physical port instance from all other instances." }, "vendorPortName":{ "type":"string", "description":"The vendor-specific name for the port." }, "customerPortName":{ "type":"string", "description":"The customer-specific name for the port." }, "physicalDeviceRef":{ "$ref":"#/components/schemas/PhysicalDevice" }, "equipmentRef":{ "$ref":"#/components/schemas/Equipment" }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" }, "description":"The list of physical port inventory roles." } } } ] }, "PhysicalConnector":{ "description":"A physical connector.", "allOf":[ { "$ref":"#/components/schemas/PhysicalResource" }, { "type":"object", "properties":{ "physicalDeviceRef":{ "$ref":"#/components/schemas/PhysicalDevice" }, "equipmentRef":{ "$ref":"#/components/schemas/Equipment" } } } ] }, "Equipment":{ "description":"An equipment resource.", "allOf":[ { "$ref":"#/components/schemas/PhysicalResource" }, { "type":"object", "properties":{ "category":{ "type":"string", "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.", "readOnly":true }, "vendorName":{ "type":"string", "description":"The name of the equipment manufacturer.", "readOnly":true }, "modelNumber":{ "type":"string", "description":"The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.", "readOnly":true }, "partNumber":{ "type":"string", "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.", "readOnly":true }, "networkLocation":{ "$ref":"#/components/schemas/PlaceRef" }, "physicalConnectors":{ "type":"string", "format":"uri", "description":"The URI for the list of physical connector instances provided by the equipment instance.", "readOnly":true }, "physicalPorts":{ "type":"string", "format":"uri", "description":"The URI for the physical port instances provided by the equipment instance.", "readOnly":true }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" }, "description":"The list of equipment inventory roles." } } } ] }, "EquipmentHolder":{ "description":"An equipment holder resource.", "allOf":[ { "$ref":"#/components/schemas/PhysicalResource" }, { "type":"object", "properties":{ "nativeEMSName":{ "type":"string", "description":"The network-facing managed element name for the resource. This name is how the resource is referred to by the NMS (Network Management System) or EMS (Element Management System). This attribute is not currently supported in UIM." } } } ] }, "LogicalDeviceAccount":{ "description":"A logical device account.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "logicalDeviceName":{ "type":"string", "description":"Name of the associated logical device.", "readOnly":true } } } ] }, "CustomObject":{ "description":"A custom object.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRef" }, "description":"The list of associated parties." }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" }, "description":"The list of custom object inventory roles." } } } ] }, "CustomNetworkAddress":{ "description":"A custom network address.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRef" }, "description":"The list of associated parties." } } } ] }, "TelephoneNumber":{ "description":"A telephone number.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "telephoneNumber":{ "type":"string", "description":"The telephone number." } } } ] }, "IPAddress":{ "description":"An IP address.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "prefixLength":{ "type":"integer", "description":"The number of bits in the prefix." }, "macAddress":{ "type":"string", "description":"The MAC address." }, "macAddressType":{ "type":"string", "description":"The type of MAC address." }, "numericAddress":{ "type":"integer", "readOnly":true }, "ipAddressDomain":{ "$ref":"#/components/schemas/NetworkAddressDomain" }, "parentSubnet":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/IPSubnet" } ], "description":"The parent IP subnet of the IP address.", "readOnly":true }, "parentNetwork":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/IPNetwork" } ], "description":"The parent IP network of the IP address.", "readOnly":true }, "ownedBy":{ "$ref":"#/components/schemas/RelatedPartyRef" }, "managedBy":{ "$ref":"#/components/schemas/RelatedPartyRef" } } } ] }, "IPV4Address":{ "description":"An IPv4 address.", "allOf":[ { "$ref":"#/components/schemas/IPAddress" }, { "type":"object", "properties":{ "ipv4Address":{ "type":"string", "description":"The IP address." } } } ] }, "IPV6Address":{ "description":"An iPv6 address.", "allOf":[ { "$ref":"#/components/schemas/IPAddress" }, { "type":"object", "properties":{ "ipv6Address":{ "type":"string", "description":"The IP address." }, "ipv6AddressType":{ "type":"string", "description":"The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST." } } } ] }, "IPNetwork":{ "description":"An IP network or IP subnet.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "ipAddress":{ "type":"string", "description":"The network's starting IP address." }, "prefixLength":{ "type":"integer", "description":"The number of bits in the address that are in the network." }, "isIPNetwork":{ "type":"boolean", "description":"Whether it's an IP network (true) or IP subnet (false)." }, "availableHostCount":{ "type":"integer", "description":"The total number of usable hosts in the network.", "readOnly":true }, "numericLowerAddress":{ "type":"integer", "description":"The numeric equivalent of the start IP address of the network.", "readOnly":true }, "numericUpperAddress":{ "type":"integer", "description":"The numeric equivalent of the end IP address of the network.", "readOnly":true }, "allowHostAtSubnetBoundaries":{ "type":"boolean", "description":"Whether the subnet's start and end addresses can be assigned to hosts (true) or not (false)." }, "ipAddressDomain":{ "$ref":"#/components/schemas/NetworkAddressDomain" }, "ipv6AddressType":{ "type":"string", "description":"The type of IPv6 address supported by the network, either GLOBAL_UNICAST or UNIQUE_LOCAL_UNICAST." }, "ipAddressVersion":{ "type":"string", "description":"The version of the IP network, either IPv4 or IPv6." }, "prefix":{ "type":"string", "description":"The prefix for the IP network.", "readOnly":true }, "ownedBy":{ "$ref":"#/components/schemas/RelatedPartyRef" } } } ] }, "IPSubnet":{ "description":"An IP subnet.", "allOf":[ { "$ref":"#/components/schemas/IPNetwork" }, { "type":"object", "properties":{ "isSubnetPartitioned":{ "type":"boolean", "description":"Whether the subnet has been partitioned (true) or not (false).", "readOnly":true }, "ipNetwork":{ "$ref":"#/components/schemas/IPNetwork" }, "managedBy":{ "$ref":"#/components/schemas/RelatedPartyRef" }, "ipAddresses":{ "type":"string", "format":"uri", "description":"The list of IP addresses for the subnet.", "readOnly":true }, "partitionedSubnets":{ "type":"array", "items":{ "$ref":"#/components/schemas/IPSubnet" }, "description":"The list of partitioned subnets.", "readOnly":true } } } ] }, "NetworkAddressDomain":{ "description":"A network address domain.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"The name of the network address domain. It also indicates the ID of the domain." }, "networkAddressType":{ "type":"string", "description":"The type of network address, either IP Subnet or flow identifier." }, "ownedBy":{ "$ref":"#/components/schemas/RelatedPartyRef" }, "managedBy":{ "$ref":"#/components/schemas/RelatedPartyRef" } } } ] }, "FlowIdentifier":{ "description":"A flow identifier.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "identifier":{ "type":"integer", "description":"The ID of the flow identifier." }, "identifierPrefix":{ "type":"string", "description":"Prefix for the Identifier." }, "domain":{ "$ref":"#/components/schemas/NetworkAddressDomain" }, "stackingLevel":{ "type":"integer", "description":"The stacking level of the flow identifier." }, "lowerIdentifierValue":{ "type":"integer", "description":"The Lower ID of the flow identifier Range." }, "upperIdentifierValue":{ "type":"integer", "description":"The Upper ID of the flow identifier Range." }, "resourcePoolName":{ "type":"string", "description":"The Resource Pool Name of flow Identifier." } } } ] }, "Pipe":{ "description":"A pipe resource.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "totalConsumedCapacity":{ "type":"string", "description":"The total consumed capacity." }, "capacityProvidedRef":{ "$ref":"#/components/schemas/CapacityProvided" }, "capacityRequiredRef":{ "$ref":"#/components/schemas/CapacityRequired" }, "capacityConsumedRef":{ "$ref":"#/components/schemas/CapacityConsumed" }, "allowSecondaryEnablement":{ "type":"boolean", "description":"To allow SecondaryEnablement for a pipe or not." }, "isVersioned":{ "type":"boolean", "description":"To denote whether pipe is versioned or not." }, "aendTerminationPoint":{ "type":"string", "format":"uri", "description":"The URI for aterminationPoint of the pipe." }, "zendTerminationPoint":{ "type":"string", "format":"uri", "description":"The URI for zterminationPoint of the pipe." }, "primaryPathEnabled":{ "$ref":"#/components/schemas/PipeEnablement" }, "secondaryPathEnabled":{ "$ref":"#/components/schemas/PipeEnablement" }, "transmissionSignalType":{ "type":"string", "description":"The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN.", "enum":[ "ELECTRICAL", "ELECTROMAGNETIC", "OPTICAL", "UNKNOWN", "NONE" ] }, "medium":{ "type":"string", "description":"The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN.", "enum":[ "WIRELESS", "METALLIC", "FIBER", "SOFTWARE", "UNKNOWN", "NONE" ] }, "gridType":{ "type":"string", "description":"The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID.", "enum":[ "FIXED", "FLEX_GRID", "NONE" ] }, "channelSpacing":{ "type":"string", "description":"The channelSpacing of pipe." }, "pipeDirectionalityRef":{ "type":"array", "items":{ "$ref":"#/components/schemas/PipeDirectionality" }, "description":"The list of pipe directionalities." }, "parentPipeRef":{ "$ref":"#/components/schemas/Pipe" }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" }, "description":"The list of pipe inventory roles." } } } ] }, "PipeTerminationPoint":{ "description":"A PipeTerminationPoint for Pipe.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "networkLocation":{ "$ref":"#/components/schemas/PlaceRef", "description":"The property location code for terminationPoint." }, "pipeRef":{ "$ref":"#/components/schemas/Pipe" }, "connectivityRef":{ "$ref":"#/components/schemas/Connectivity" } } } ] }, "CapacityProvided":{ "type":"object", "description":"A capacity provided.", "properties":{ "capacityType":{ "type":"string", "description":"Capacity type of capacity provided." }, "totalAmount":{ "type":"string", "description":"Total amount of capacity provided." }, "unitOfMeasure":{ "type":"string", "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps." }, "consumablePercentage":{ "type":"string", "description":"Percentage of capacity that can be consumable." } } }, "CapacityRequired":{ "type":"object", "description":"Required capacity of pipe.", "properties":{ "capacityType":{ "type":"string", "description":"Capacity type of required capacity." }, "requiredAmount":{ "type":"string", "description":"Required amount of capacity." }, "unitOfMeasure":{ "type":"string", "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps." }, "quantity":{ "type":"integer", "description":"Percentage of capacity that can be consumable." } } }, "CapacityConsumed":{ "type":"object", "description":"Consumed capacity of pipe.", "properties":{ "id":{ "type":"string", "description":"The id of the CapacityConsumed." }, "name":{ "type":"string", "description":"The name of the CapacityConsumed." }, "percentConsumed":{ "type":"string", "description":"Consumed capacity percentage." }, "capacityConsumed":{ "type":"string", "description":"Capacity consumed." } } }, "PipeDirectionality":{ "type":"object", "description":"A Pipe Directionality .", "properties":{ "pipeDirection":{ "type":"string", "description":"The direction of the pipe.", "enum":[ "BI_DIRECTIONAL", "UNI_DIRECTIONAL", "UNKNOWN" ] }, "directionalityType":{ "type":"string", "description":"The directionalityType of the pipe.", "enum":[ "ROUTING", "SIGNAL" ] }, "terminationId1":{ "type":"string", "description":"The ID of the termination1." }, "terminationId2":{ "type":"string", "description":"The ID of the termination2." }, "terminationName1":{ "type":"string", "description":"The name of the termination1." }, "terminationName2":{ "type":"string", "description":"The name of the termination2." }, "terminationDirectType1":{ "type":"string", "description":"The DirectType of the termination1. Valid values are SINK, SOURCE, UNKNOWN.", "enum":[ "SINK", "SOURCE", "UNKNOWN" ] }, "terminationDirectType2":{ "type":"string", "description":"The DirectType of the termination2. Valid values are SINK, SOURCE, UNKNOWN.", "enum":[ "SINK", "SOURCE", "UNKNOWN" ] } } }, "PipeEnablement":{ "type":"object", "description":"Segment details that are enabling current Connectivity.", "properties":{ "originatingTerminationPoint":{ "type":"string", "description":"The id of the originatingTerminationPoint." }, "terminatingTerminationPoint":{ "type":"string", "description":"The id of the terminatingTerminationPoint." }, "pipeSegmentRef":{ "type":"array", "items":{ "$ref":"#/components/schemas/Segment" }, "description":"The list of pipe segments." } } }, "Connectivity":{ "description":"A Connectivity resource.", "allOf":[ { "$ref":"#/components/schemas/LogicalResource" }, { "type":"object", "properties":{ "connectivityIdentifier":{ "type":"string", "description":"A unique identifier of Connectivity." }, "technology":{ "type":"string", "description":"The technology that applies to connectivity." }, "identificationFormat":{ "$ref":"#/components/schemas/ConnectivityIdentifierFormatEnum" }, "ALocation":{ "$ref":"#/components/schemas/PlaceRef", "description":"The network location code or network entity code for the A side of the connectivity." }, "ZLocation":{ "$ref":"#/components/schemas/PlaceRef", "description":"The network location code or network entity code for the Z side of the connectivity." }, "rateCode":{ "type":"string", "description":"The rate code that applies to connectivity." }, "function":{ "type":"string", "description":"The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities." }, "functionDisplayName":{ "type":"string", "description":"The display name of the function.", "readOnly":true }, "serialNumber":{ "type":"integer", "description":"A number that uniquely identifies the connectivity within the context of other facilities that share the same A Network/Entity Location, Z Network/Entity Location, Rate Code, and Technology values." }, "quantity":{ "type":"integer", "description":"The number of Connectivity entities to be created." }, "isAssignContiguousSerialNumber":{ "type":"boolean", "description":"Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block." }, "consumablePercent":{ "type":"integer", "description":"Percentage of capacity that can be consumed." }, "capacityAvailable":{ "type":"string", "description":"Percentage of capacity that can be consumed." }, "bitRate":{ "type":"string", "description":"The bit rate is based on the rate code applied to the connectivity." }, "assignedToService":{ "type":"string", "format":"uri", "description":"The service (if any) to which the connectivity is assigned." }, "connectivityDesign":{ "$ref":"#/components/schemas/ConnectivityDesign" } } } ] }, "PacketNetworkConnectivity":{ "description":"A Connectivity resource.", "allOf":[ { "$ref":"#/components/schemas/Connectivity" }, { "type":"object", "properties":{ "isInternetwork":{ "type":"boolean", "description":"If it is inter network or not." }, "isInternetworkExternal":{ "type":"boolean", "description":"If it is internetwork external or not." }, "otherServiceProviderName":{ "$ref":"#/components/schemas/Party" }, "otherProviderDemarcationPoint":{ "$ref":"#/components/schemas/AZLocationTypeEnum" } } } ] }, "EthernetENNIConnectivity":{ "description":"A EthernetENNIConnectivity resource.", "allOf":[ { "$ref":"#/components/schemas/PacketNetworkConnectivity" } ] }, "EthernetINNIConnectivity":{ "description":"A EthernetINNIConnectivity resource.", "allOf":[ { "$ref":"#/components/schemas/PacketNetworkConnectivity" } ] }, "PacketNetworkAccessConnectivity":{ "description":"A PacketNetworkAccessConnectivity resource.", "allOf":[ { "$ref":"#/components/schemas/Connectivity" } ] }, "EthernetUNIConnectivity":{ "description":"A EthernetUNIConnectivity resource.", "allOf":[ { "$ref":"#/components/schemas/PacketNetworkAccessConnectivity" }, { "type":"object", "properties":{ "isServiceMultiplexing":{ "type":"boolean", "description":"If it is service multiplexing or not." }, "isBundling":{ "type":"boolean", "description":"If it is bundling or not." }, "isAllToOneBundling":{ "type":"boolean", "description":"If all to one bundling is applicable." }, "isVlanBased":{ "type":"boolean", "description":"If it is vlan based or not." }, "maxPacketVirtualNetworkCount":{ "type":"integer", "description":"count of maximum packet virtual network." } } } ] }, "ChannelizedConnectivity":{ "description":"A ChannelizedConnectivity resource.", "allOf":[ { "$ref":"#/components/schemas/Connectivity" } ] }, "ServiceConnectivity":{ "description":"A ServiceConnectivity resource.", "allOf":[ { "$ref":"#/components/schemas/Connectivity" }, { "type":"object", "properties":{ "committedInformationRateDisplay":{ "type":"string", "description":"Information rate. Should be in the format bitrate space unitOfMeasure." }, "maxInformationRateDisplay":{ "type":"string", "description":"maximum information rate. Should be in the format bitrate space unitOfMeasure." } } } ] }, "ConnectivityIdentifierFormatEnum":{ "description":"The list of valid values for Connectivity identifier format.", "type":"string", "enum":[ "LOCATION_BASED", "SERVICE_BASED", "CUSTOM_IDENTIFICATION" ] }, "AZLocationTypeEnum":{ "description":"The list of valid values for AZLocationType.", "type":"string", "enum":[ "A_LOCATION", "Z_LOCATION" ] }, "ConnectivityDesign":{ "type":"object", "description":"Gives the details of latest connectivity design version.", "properties":{ "connectivityDesignVersion":{ "type":"integer", "description":"The version number of connectivity design." }, "startDate":{ "type":"string", "format":"date-time", "description":"The starting date and time when the connectivity design becomes effective." }, "status":{ "$ref":"#/components/schemas/ConfigurationStateEnum", "description":"The configuration status of latest connectivity design version." }, "asideTerminationPointId":{ "type":"string", "description":"The id of Termination point on A side." }, "zsideTerminationPointId":{ "type":"string", "description":"The id of Termination point on Z side." }, "aendLocation":{ "$ref":"#/components/schemas/PlaceRef", "description":"The network location code or network entity code for the A side of the connectivity." }, "zendLocation":{ "$ref":"#/components/schemas/PlaceRef", "description":"The network location code or network entity code for the Z side of the connectivity." }, "asideInterface":{ "$ref":"#/components/schemas/LogicalResource", "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity." }, "zsideInterface":{ "$ref":"#/components/schemas/LogicalResource", "description":"The DeviceInterface or FlowInterface for Z side interface of the connectivity." }, "asideFlowIdentifiers":{ "type":"array", "items":{ "$ref":"#/components/schemas/FlowIdentifier" } }, "zsideFlowIdentifiers":{ "type":"array", "items":{ "$ref":"#/components/schemas/FlowIdentifier" } }, "terminateAtFlowInterfaceOnAside":{ "type":"boolean", "description":"This should be true if A side needs to be terminated at Flow Interface." }, "terminateAtFlowInterfaceOnZside":{ "type":"boolean", "description":"This should be true if Z side needs to be terminated at Flow Interface." }, "paths":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConnectivityPath" } } } }, "ConnectivityPath":{ "type":"object", "description":"Paths that are enabling current Connectivity.", "properties":{ "label":{ "type":"string", "description":"Path label like Path1, Path2." }, "segments":{ "type":"array", "items":{ "$ref":"#/components/schemas/Segment" } } } }, "Segment":{ "type":"object", "description":"Segment details that are enabling current Connectivity.", "properties":{ "segmentNumber":{ "type":"string", "description":"Segment number." }, "asideTerminationPoint":{ "type":"string", "description":"The id of Termination point." }, "asideInterface":{ "$ref":"#/components/schemas/LogicalResource", "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity." }, "asidePhysicalPort":{ "$ref":"#/components/schemas/LogicalResource" }, "aendLocation":{ "type":"string", "description":"A side Location." }, "segmentRef":{ "oneOf":[ { "$ref":"#/components/schemas/Pipe" }, { "$ref":"#/components/schemas/Connectivity" } ] }, "flowIdentifiers":{ "type":"array", "items":{ "$ref":"#/components/schemas/FlowIdentifier" } }, "isGap":{ "type":"boolean", "description":"Identifies if it is a gap or not." }, "interconnectionType":{ "$ref":"#/components/schemas/InterConnectionTypeEnum" }, "zsideTerminationPoint":{ "type":"string", "description":"The id of Termination point." }, "zsideInterface":{ "$ref":"#/components/schemas/LogicalResource", "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity." }, "zendLocation":{ "type":"string", "description":"Z side Location." }, "zsidePhysicalPort":{ "$ref":"#/components/schemas/LogicalResource" }, "gapAccepted":{ "type":"boolean", "description":"Use this attribute to accept gap. Default Reason for accepting gap is auto-generated as \"GAP OK\"" }, "lifeCycleBinding":{ "$ref":"#/components/schemas/InterConnectionLifeCycleBindingEnum" } } }, "InterConnectionLifeCycleBindingEnum":{ "description":"The list of valid values for InterConnectionLifeCycleBinding.", "type":"string", "enum":[ "INTERFACE_BOUND", "TRAIL_BOUND", "HARDWIRED" ] }, "InterConnectionTypeEnum":{ "description":"The list of valid values for InterConnectionType.", "type":"string", "enum":[ "CROSS_CONNECT", "PHYSICAL_JUMPER" ] }, "ConnectivityTaskEnum":{ "type":"string", "description":"Valid tasks/actions for the Connectivity.", "enum":[ "COMPLETE", "CANCEL" ] }, "RehomeProject":{ "type":"object", "description":"Rehome Project Class.", "properties":{ "id":{ "type":"string", "description":"The ID of the project.", "readOnly":true }, "href":{ "type":"string", "description":"The URI for the RehomeProject class.", "format":"uri", "readOnly":true }, "projectName":{ "type":"string", "description":"The name of the project." }, "description":{ "type":"string", "description":"A free-text description for the project." }, "status":{ "$ref":"#/components/schemas/ProjectStateEnum", "readOnly":true }, "activity":{ "description":"Activity", "$ref":"#/components/schemas/RehomeActivity" } } }, "RehomeActivity":{ "type":"object", "description":"Rehome activity is used to change the terminations of Connectivity or Pipe. Pipe and connectivity trails riding on the rehomed connectivity require design changes to reflect new interface and cross-connect assignments.", "properties":{ "id":{ "type":"string", "description":"The ID of the Activity." }, "activityName":{ "type":"string", "description":"The name of the activity." }, "status":{ "$ref":"#/components/schemas/ActivityStateEnum" }, "activityItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/RehomeActivityItem" } }, "impactedItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImpactedItem" } } } }, "RehomeActivityItem":{ "type":"object", "description":"Rehome activity item captures details of the connectivity or pipe to be rehomed.", "properties":{ "changedEntity":{ "description":"Connectivity or Pipe to be rehomed.", "oneOf":[ { "$ref":"#/components/schemas/Pipe" }, { "$ref":"#/components/schemas/Connectivity" } ] }, "source":{ "description":"Source Interface or Port on which the connectivity/pipe is currently terminated.", "oneOf":[ { "$ref":"#/components/schemas/PhysicalPort" }, { "$ref":"#/components/schemas/DeviceInterface" } ] }, "target":{ "description":"Target Interface or Port on which the connectivity/pipe needs to be terminated.", "oneOf":[ { "$ref":"#/components/schemas/PhysicalPort" }, { "$ref":"#/components/schemas/DeviceInterface" } ] }, "status":{ "description":"Status of rehome activity item.", "$ref":"#/components/schemas/ActivityStateEnum" }, "comments":{ "type":"string", "description":"Comments related to failure of rehome activity items, if any." } } }, "ReplaceCardProject":{ "type":"object", "description":"ReplaceCard Project Class.", "properties":{ "id":{ "type":"string", "description":"The ID of the project.", "readOnly":true }, "href":{ "type":"string", "description":"The URI for the ReplaceCardProject class.", "format":"uri", "readOnly":true }, "projectName":{ "type":"string", "description":"The name of the project." }, "description":{ "type":"string", "description":"A free-text description for the project." }, "status":{ "$ref":"#/components/schemas/ProjectStateEnum", "readOnly":true }, "activity":{ "description":"Activity", "$ref":"#/components/schemas/ReplaceCardActivity" } } }, "ReplaceCardActivity":{ "type":"object", "description":"ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.", "properties":{ "id":{ "type":"string", "description":"The ID of the Activity." }, "activityName":{ "type":"string", "description":"The name of the activity." }, "autoMap":{ "type":"boolean", "description":"Auto maps the consumers of source card's physical ports to target card's physical ports in the same order." }, "sourceCard":{ "description":"The source card which is replaced from it's parent equipment.", "$ref":"#/components/schemas/Equipment" }, "targetCard":{ "description":"The target card which is replacing the source card and is added in the parent Shelf equipment.", "$ref":"#/components/schemas/Equipment" }, "status":{ "$ref":"#/components/schemas/ActivityStateEnum" }, "activityItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/ReplaceCardActivityItem" } }, "impactedItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImpactedItem" } } } }, "ReplaceCardActivityItem":{ "type":"object", "description":"A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.", "properties":{ "changedEntity":{ "description":"The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.", "oneOf":[ { "$ref":"#/components/schemas/Pipe" }, { "$ref":"#/components/schemas/Connectivity" }, { "$ref":"#/components/schemas/Equipment" } ] }, "serviceChangedEntity":{ "description":"Service consumers of the port of the source card.", "$ref":"#/components/schemas/Service" }, "source":{ "description":"Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.", "oneOf":[ { "$ref":"#/components/schemas/PhysicalPort" }, { "$ref":"#/components/schemas/Equipment" } ] }, "target":{ "description":"Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.", "oneOf":[ { "$ref":"#/components/schemas/PhysicalPort" }, { "$ref":"#/components/schemas/Equipment" } ] }, "status":{ "$ref":"#/components/schemas/ActivityStateEnum" }, "comments":{ "type":"string", "description":"Comments related to failure of replace card activity items if any." } } }, "ImpactedItem":{ "type":"object", "description":"Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.", "properties":{ "action":{ "type":"string", "description":"If impacted connectivity/pipe design does not have any gap, then the action is VIEW DESIGN. If impacted connectivity/pipe design is not completed due to gap, then the action is RESOLVE GAP. If impacted item is service then the action is VIEW SERVICE." }, "changedEntity":{ "description":"Impacted Connectivity or Pipe after rehome or groom.", "oneOf":[ { "$ref":"#/components/schemas/Pipe" }, { "$ref":"#/components/schemas/Connectivity" }, { "$ref":"#/components/schemas/Equipment" } ] }, "serviceChangeEntity":{ "description":"Impacted Service after rehome service.", "$ref":"#/components/schemas/Service" }, "status":{ "description":"Status of impacted item.", "$ref":"#/components/schemas/ActivityStateEnum" }, "parentChangeItem":{ "type":"string", "description":"Parent activity item due to which this item got imapacted." } } }, "GroomProject":{ "type":"object", "description":"Groom Project Class.", "properties":{ "id":{ "type":"string", "description":"The ID of the project.", "readOnly":true }, "href":{ "type":"string", "description":"The URI for the GroomProject class.", "format":"uri", "readOnly":true }, "projectName":{ "type":"string", "description":"The name of the project." }, "description":{ "type":"string", "description":"A free-text description for the project." }, "status":{ "$ref":"#/components/schemas/ProjectStateEnum" }, "activity":{ "description":"Activity", "$ref":"#/components/schemas/GroomActivity" } } }, "GroomActivity":{ "type":"object", "description":"Groom activity is used to change the design of Connectivity or Pipe even if the trails are riding on it. It will move a rider from source bearers to target bearers.", "properties":{ "id":{ "type":"string", "description":"The ID of the Activity." }, "activityName":{ "type":"string", "description":"The name of the activity." }, "status":{ "$ref":"#/components/schemas/ActivityStateEnum" }, "activityItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/GroomActivityItem" } }, "impactedItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImpactedItem" } } } }, "GroomActivityItem":{ "type":"object", "description":"Groom activity item captures the details of the connectivity or pipe to be groomed.", "properties":{ "changedEntity":{ "description":"Connectivity or Pipe to be groomed.", "oneOf":[ { "$ref":"#/components/schemas/Pipe" }, { "$ref":"#/components/schemas/Connectivity" } ] }, "source":{ "description":"The source connectivity/pipe on which the connectivity/pipe to be groomed is currently riding.", "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/Pipe" }, { "$ref":"#/components/schemas/Connectivity" } ] } }, "target":{ "description":"The target connectivity/pipe on which the connectivity/pipe to be groomed needs to ride.", "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/Pipe" }, { "$ref":"#/components/schemas/Connectivity" } ] } }, "status":{ "$ref":"#/components/schemas/ActivityStateEnum" }, "comments":{ "type":"string", "description":"Comments related to failure of groom activity item, if any." } } }, "ActivityStateEnum":{ "description":"The list of valid values for Activity State.", "type":"string", "enum":[ "PENDING", "READY", "IN_PROGRESS", "ABORTED", "ERROR", "FAILED", "PENDING_COMPLETE", "COMPLETED", "PENDING_PROCESS", "PENDING_ABORT" ] }, "ProjectStateEnum":{ "description":"The list of valid values for Project State.", "type":"string", "enum":[ "CREATED", "COMPLETED", "IN_PROGRESS" ] }, "GroomRehomeTaskEnumType":{ "description":"The list of valid actions for Groom Rehome activity tasks.", "type":"string", "enum":[ "VALIDATE", "SUBMIT", "CANCEL" ] }, "Path":{ "type":"object", "description":"Path class", "properties":{ "source":{ "$ref":"#/components/schemas/Vertex" }, "destination":{ "$ref":"#/components/schemas/Vertex" }, "edges":{ "type":"array", "items":{ "$ref":"#/components/schemas/Edge" } } } }, "Vertex":{ "type":"object", "description":"Vertex class", "properties":{ "id":{ "type":"string", "description":"The id of the Vertex." }, "entityId":{ "type":"number", "description":"The entityId of the Vertex." }, "name":{ "type":"string", "description":"The name of the Vertex." }, "businessObjectClass":{ "type":"string", "description":"The businessObjectClass of the Vertex." }, "deviceInterfaceId":{ "type":"string", "description":"The deviceInterface id on which Pipe/Connectivity is terminated." }, "deviceInterfaceName":{ "type":"string", "description":"The deviceInterface name on which Pipe/Connectivity is terminated." }, "physicalPortId":{ "type":"string", "description":"The physicalPort id on which Pipe is terminated." }, "physicalPortName":{ "type":"string", "description":"The physicalPort name on which Pipe is terminated." }, "capacityConsumed":{ "type":"integer", "description":"Amount of capacity consumed of this vertex." } } }, "Edge":{ "type":"object", "description":"Edge class", "properties":{ "id":{ "type":"string", "description":"The id of the Edge." }, "name":{ "type":"string", "description":"The name of the Edge." }, "businessObjectClass":{ "type":"string", "description":"The businessObjectClass of Edge." }, "channels":{ "type":"array", "description":"The text that provides more details about the error as well as corrective actions.", "items":{ "type":"string" } }, "fromNode":{ "type":"number", "description":"The id of from Node." }, "fromNodeData":{ "type":"string", "description":"The name of device interface or physical port at A side." }, "fromNodeBusinessObjectClass":{ "type":"string", "description":"The business object class of fromNode." }, "toNode":{ "type":"number", "description":"The id of to Node." }, "toNodeData":{ "type":"string", "description":"The name of device interface or physical port at Z side." }, "toNodeBusinessObjectClass":{ "type":"string", "description":"The business object class of toNode." }, "fromNodeCapacityConsumed":{ "type":"integer", "description":"Amount of capacity consumed of the fromNode vertex of this edge." }, "toNodeCapacityConsumed":{ "type":"integer", "description":"Amount of capacity consumed of the toNode vertex of this edge." }, "pathIds":{ "type":"array", "description":"List of paths the edge is part of. This list will have more than one values only when the edge is shared between multiple paths." } } }, "Party":{ "type":"object", "description":"Details of Party", "properties":{ "id":{ "type":"string", "description":"The ID of the party." }, "href":{ "type":"string", "format":"uri", "description":"The URI for the party." }, "name":{ "type":"string", "description":"The name of the party." }, "resourceCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" }, "description":"The list of characteristics for the resource." }, "resourceSpecification":{ "$ref":"#/components/schemas/Specification" }, "roles":{ "type":"array", "items":{ "$ref":"#/components/schemas/Role" } } } }, "ResourceReservation":{ "type":"object", "description":"reservation api resource", "required":[ "reservedForType", "reservedFor", "reservationType", "startDate" ], "properties":{ "reservationNumber":{ "type":"string", "description":"Reservation number of the entities got reserved" }, "reservedForType":{ "$ref":"#/components/schemas/ReservedForType", "description":"ReservedForType of the reservation" }, "reservedFor":{ "type":"string", "description":"Name of whom the resource is reserved for" }, "reservationType":{ "$ref":"#/components/schemas/ReservationType", "description":"ReservationType of the Reservation" }, "startDate":{ "type":"string", "format":"date", "description":"The start date of the reservation", "example":"2024-08-22" }, "expiryDate":{ "type":"string", "format":"date", "description":"The expiry date of the reservation", "example":"2024-08-22" }, "reason":{ "type":"string", "description":"Reason for the reservation" }, "resourceItems":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceReservationItem" } } } }, "ReservedForType":{ "enum":[ "Area", "CSR", "Customer", "Order", "Project", "Service", "ServiceSpec", "Subscriber" ], "type":"string", "description":"ReservedForType of the Reservation" }, "ReservationType":{ "enum":[ "Longterm", "Shortterm" ], "type":"string", "description":"ReservationType of the reservation" }, "ResourceReservationItem":{ "type":"object", "description":"id and type of resource", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"id of the resource" }, "name":{ "type":"string", "description":"name of the resource" } } }, "EntityResourceReservation":{ "type":"object", "description":"resource reservation api resource", "required":[ "reservationNumber", "resourceId", "reservationType", "startDate" ], "properties":{ "reservationNumber":{ "type":"string", "description":"reservation number of the resource's reservation" }, "resourceId":{ "type":"string", "description":"id of the resource" }, "name":{ "type":"string", "description":"name of the resource" }, "@type":{ "$ref":"#/components/schemas/ResourceTypeEnum", "description":"type of the resource" }, "reservedForType":{ "$ref":"#/components/schemas/ReservedForType" }, "reservedFor":{ "type":"string", "description":"Name of whom the resource is reserved for" }, "reservationType":{ "$ref":"#/components/schemas/ReservationType" }, "startDate":{ "type":"string", "format":"date", "description":"The start date of the reservation", "example":"2024-08-22" }, "expiryDate":{ "type":"string", "format":"date", "description":"The expiry date of the reservation", "example":"2024-08-22" }, "reason":{ "type":"string", "description":"Reason for the reservation" } } }, "Service":{ "type":"object", "description":"Service Class.", "properties":{ "id":{ "type":"string", "description":"The ID of the service.", "readOnly":true }, "href":{ "type":"string", "description":"The URI for the service class.", "readOnly":true }, "businessInteraction":{ "$ref":"#/components/schemas/BusinessInteractionRef", "description":"A related Business Interaction. A related business interaction linked to a specific entity." }, "category":{ "type":"string", "description":"Indicates if it is customer facing or resource facing service." }, "description":{ "type":"string", "description":"A free-text description for the service." }, "endDate":{ "type":"string", "format":"date-time", "description":"The date and time when the service is no longer effective." }, "hasStarted":{ "type":"boolean", "description":"Flag indicates that service is started.", "readOnly":true }, "isServiceEnabled":{ "type":"boolean", "description":"If FALSE, this particular Service has NOT been enabled for use", "readOnly":true }, "name":{ "type":"string", "description":"The name of the service." }, "serviceDate":{ "type":"string", "format":"date-time", "description":"Date and time when the service was created (whatever its status).", "readOnly":true }, "supportingResource":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceServiceRef" }, "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS." }, "startDate":{ "type":"string", "format":"date-time", "description":"The date and time when the service is started." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyServiceRef" }, "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity." }, "serviceCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceCharacteristic" }, "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) " }, "serviceRelationship":{ "type":"array", "description":"A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).", "items":{ "$ref":"#/components/schemas/ServiceRelationship" } }, "serviceType":{ "type":"string", "description":"The business type of the service." }, "supportingService":{ "type":"array", "items":{ "$ref":"#/components/schemas/Service" }, "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)." }, "serviceSpecification":{ "$ref":"#/components/schemas/Specification" }, "state":{ "$ref":"#/components/schemas/ServiceStateEnum" }, "place":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlaceServiceRef" }, "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources." }, "externalIdentity":{ "$ref":"#/components/schemas/ExternalIdentity" }, "serviceOrderItem":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedServiceOrderItem" }, "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service." }, "effectiveDate":{ "type":"string", "format":"date-time", "description":"The date and time when the service changes goes to activate." } } }, "BundleService":{ "type":"object", "description":"Bundle Service.", "properties":{ "id":{ "type":"string", "description":"The ID of the Parent BusinessInteraction." }, "state":{ "type":"string", "description":"The state of the Parent BusinessInteraction." }, "effectiveDate":{ "type":"string", "format":"date-time", "description":"The date and time when the bundle goes to activate." }, "href":{ "type":"string", "description":"The URI for the Parent BusinessInteraction Item class." }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/Service" }, "description":"A list of items (Service [*])." } } }, "RelatedServiceOrderItem":{ "type":"object", "required":[ "itemId", "serviceOrderId" ], "description":"The service order item which triggered service creation/change/termination.", "properties":{ "itemAction":{ "$ref":"#/components/schemas/OrderItemActionEnum" }, "itemId":{ "type":"string", "description":"Identifier of the order item where the service was managed." }, "role":{ "type":"string", "description":"Role of the service order item for this service." }, "serviceOrderHref":{ "type":"string", "description":"Reference of the related entity." }, "serviceOrderId":{ "type":"string", "description":"Unique identifier of a related entity." } } }, "OrderItemActionEnum":{ "type":"string", "description":"Valid values for the lifecycle state of the orderItemAction.", "enum":[ "add", "modify", "delete", "noChange" ] }, "ServiceStateEnum":{ "type":"string", "description":"Valid values for the lifecycle state of the service.", "enum":[ "designed", "inactive", "active", "terminated", "pendingCancel", "cancelled", "pendingDisconnect", "cancelPendingDisconnect" ] }, "ServiceTaskEnum":{ "type":"string", "description":"Valid tasks for the Service.", "enum":[ "approve", "issue", "activate", "cancel" ] }, "ReferenceTypeEnum":{ "description":"Valid values for the list of supported reference types.", "type":"string", "enum":[ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ] }, "ServiceRelationship":{ "required":[ "relationshipType", "service" ], "type":"object", "properties":{ "relationshipType":{ "type":"string", "description":"The type of relationship (e.g. depends on, enables)" }, "service":{ "$ref":"#/components/schemas/Service" }, "serviceRelationshipCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceCharacteristic" } } }, "description":"Describes links with services of the same category (useful for bundled services)." }, "ResourceServiceRef":{ "description":"The resource reference on a service.", "allOf":[ { "$ref":"#/components/schemas/ResourceRef" }, { "type":"object", "properties":{ "consumerName":{ "type":"string", "description":"The name of the service consumer." }, "assignmentState":{ "$ref":"#/components/schemas/AssignmentStateEnum" }, "referenceState":{ "$ref":"#/components/schemas/ReferenceStateEnum" }, "expandResource":{ "$ref":"#/components/schemas/ResourceBase" }, "configItemId":{ "type":"string", "description":"The config item id of the resource." }, "configItemName":{ "type":"string", "description":"The config item name of the resource." }, "configItemDisplayName":{ "type":"string", "description":"The config item display name of the resource which is editable from UI." } } } ] }, "RelatedPartyServiceRef":{ "description":"The party reference on a service.", "allOf":[ { "$ref":"#/components/schemas/RelatedPartyRef" }, { "type":"object", "properties":{ "referenceType":{ "$ref":"#/components/schemas/ReferenceTypeEnum", "description":"The type of the reference." }, "consumerName":{ "type":"string", "description":"The name of the service consumer." }, "referenceState":{ "$ref":"#/components/schemas/ReferenceStateEnum" }, "partySpecification":{ "$ref":"#/components/schemas/Specification" }, "partyCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" }, "description":"The list of characteristics for the party." }, "configItemId":{ "type":"string", "description":"The config item id of the party." }, "configItemName":{ "type":"string", "description":"The config item name of the party." }, "configItemDisplayName":{ "type":"string", "description":"The config item display name of the party which is editable from UI." } } } ] }, "PlaceServiceRef":{ "description":"The place reference on a service.", "allOf":[ { "$ref":"#/components/schemas/PlaceRef" }, { "type":"object", "properties":{ "referenceType":{ "$ref":"#/components/schemas/ReferenceTypeEnum", "description":"The type of the reference." }, "consumerName":{ "type":"string", "description":"The name of the service consumer." }, "resourceName":{ "type":"string", "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'." }, "assignmentState":{ "$ref":"#/components/schemas/AssignmentStateEnum" }, "referenceState":{ "$ref":"#/components/schemas/ReferenceStateEnum" }, "latitude":{ "type":"string", "description":"Latitude of the place." }, "longitude":{ "type":"string", "description":"Longitude of the place." }, "placeSpecification":{ "$ref":"#/components/schemas/Specification" }, "placeCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" }, "description":"The list of characteristics for the place." }, "configItemId":{ "type":"string", "description":"The config item id of the place." }, "configItemName":{ "type":"string", "description":"The config item name of the place." }, "configItemDisplayName":{ "type":"string", "description":"The config item display name of the place which is editable from UI." } } } ] }, "ServiceCharacteristic":{ "description":"The service characteristic details.", "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "properties":{ "serviceName":{ "type":"string", "description":"The name of the service consumer." }, "serviceSpecName":{ "type":"string", "description":"The specification name of service.Required only for creation of the service." }, "configItemId":{ "type":"string", "description":"The config item id of the service characteristic." }, "configItemName":{ "type":"string", "description":"The config item name of the service characteristic." }, "configItemDisplayName":{ "type":"string", "description":"The config item display name of the service characteristic which is editable from UI." }, "configItemPath":{ "type":"string", "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed." }, "isDesignParameter":{ "type":"boolean", "description":"If TRUE, this will be considered as a design parameter and not as a service characteristic. In this case, serviceSpecName or configItemPath are not mandatory.", "default":false } } } ] }, "BusinessInteractionRef":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of Business Interaction" }, "state":{ "type":"string", "description":"The state of Business Interaction" } } }, "UpdateConsumableResource":{ "type":"object", "required":[ "oldResourceId", "newResourceId" ], "properties":{ "oldResourceId":{ "type":"string" }, "newResourceId":{ "type":"string" }, "entityClass":{ "type":"string", "$ref":"#/components/schemas/EntityClassEnum" } } }, "PatchRequest":{ "type":"array", "items":{ "description":"A list of PATCH documents for a request.", "$ref":"#/components/schemas/PatchDocument" } }, "PatchDocument":{ "description":"A JSON PATCH document.", "required":[ "op", "path" ], "properties":{ "op":{ "type":"string", "enum":[ "add", "remove", "replace" ] }, "path":{ "type":"string", "description":"A JSON pointer indicating where to perform the operation." }, "value":{ "type":"object", "description":"The value to use with the operation." } } }, "OutageImpactEntitiyCounts":{ "type":"object", "description":"Counts of various impacted entities during an outage for the given impacted entity.", "properties":{ "id":{ "type":"string", "description":"Unique identifier for the impacted entity for which the counts of impacted entities are retrieved." }, "name":{ "type":"string", "description":"Name for the impacted entity for which the counts of impacted entities are retrieved." }, "equipmentImpactsCount":{ "type":"integer", "description":"Number of equipment items impacted by the outage." }, "physicalDeviceImpactsCount":{ "type":"integer", "description":"Number of physical devices impacted by the outage." }, "logicalDeviceImpactsCount":{ "type":"integer", "description":"Number of logical devices impacted by the outage." }, "pipeImpactsCount":{ "type":"integer", "description":"Number of pipes impacted by the outage." }, "networkImpactsCount":{ "type":"integer", "description":"Number of networks impacted by the outage." }, "serviceImpactsCount":{ "type":"integer", "description":"Number of services impacted by the outage." }, "locationImpactsCount":{ "type":"integer", "description":"Number of locations impacted by the outage." }, "partyImpactsCount":{ "type":"integer", "description":"Number of parties impacted by the outage." }, "flowIdentifierImpactsCount":{ "type":"integer", "description":"Number of flow identifiers impacted by the outage." } } }, "EquipmentOutageImpacts":{ "type":"object", "description":"Details of entities impacted by an outage of equipment.", "properties":{ "equipmentId":{ "type":"string", "description":"Unique identifier of the impacted equipment." }, "equipmentName":{ "type":"string", "description":"Name of the impacted equipment." }, "impacts":{ "type":"array", "description":"List of impacted entities by an outage of equipment.", "items":{ "$ref":"#/components/schemas/OutageImpactEntity" } } } }, "PhysicalPortOutageImpacts":{ "type":"object", "description":"Details of entities impacted by an outage of physical port.", "properties":{ "portId":{ "type":"string", "description":"Unique identifier of the impacted physical port." }, "portNumber":{ "type":"string", "description":"Number or identifier of the impacted physical port." }, "impacts":{ "type":"array", "description":"List of impacted entities by an outage of physical port.", "items":{ "$ref":"#/components/schemas/OutageImpactEntity" } } } }, "DeviceInterfaceOutageImpacts":{ "type":"object", "description":"Details of entities impacted by an outage of device interface.", "properties":{ "deviceInterfaceId":{ "type":"string", "description":"Unique identifier of the impacted device interface." }, "deviceInterfaceName":{ "type":"string", "description":"Name of the impacted device interface." }, "impacts":{ "type":"array", "description":"List of impacted entities by an outage of device interface.", "items":{ "$ref":"#/components/schemas/OutageImpactEntity" } } } }, "LogicalDeviceOutageImpacts":{ "type":"object", "description":"Details of entities impacted by an outage of logical device.", "properties":{ "logicalDeviceId":{ "type":"string", "description":"Unique identifier of the impacted logical device." }, "logicalDeviceName":{ "type":"string", "description":"Name of the impacted logical device." }, "impacts":{ "type":"array", "description":"List of impacted entities by an outage of logical device.", "items":{ "$ref":"#/components/schemas/OutageImpactEntity" } } } }, "PhysicalDeviceOutageImpacts":{ "type":"object", "description":"Details of entities impacted by an outage of physical device.", "properties":{ "physicalDeviceId":{ "type":"string", "description":"Unique identifier of the impacted physical device." }, "physicalDeviceName":{ "type":"string", "description":"Name of the impacted physical device." }, "impacts":{ "type":"array", "description":"List of impacted entities by an outage of physical device.", "items":{ "$ref":"#/components/schemas/OutageImpactEntity" } } } }, "ConnectivityOutageImpacts":{ "type":"object", "description":"Details of entities impacted by an outage of connectivity/pipe.", "properties":{ "connectivityIdentifier":{ "type":"string", "description":"Unique identifier of the impacted connectivity." }, "pipeId":{ "type":"string", "description":"Identifier of the impacted pipe." }, "pipeName":{ "type":"string", "description":"Name of the impacted pipe." }, "impacts":{ "type":"array", "description":"List of impacted entities by an outage of connectivity/pipe.", "items":{ "$ref":"#/components/schemas/OutageImpactEntity" } } } }, "GeographicPlaceOutageImpacts":{ "type":"object", "description":"Details of entities impacted by an outage of geographic place.", "properties":{ "placeId":{ "type":"string", "description":"Unique identifier of the impacted geographic place." }, "placeName":{ "type":"string", "description":"Name of the impacted geographic place." }, "impacts":{ "type":"array", "description":"List of impacted entities by an outage of geographic place.", "items":{ "$ref":"#/components/schemas/OutageImpactEntity" } } } }, "OutageImpactEntity":{ "type":"object", "description":"Detailed information about an entity impacted by an outage.", "properties":{ "connectivityIdentifier":{ "type":"string", "description":"The identifier of impacted Connectivity.", "readOnly":true }, "id":{ "type":"string", "description":"The ID of the impacted entity.", "readOnly":true }, "name":{ "type":"string", "description":"The name of the impacted entity.", "readOnly":true }, "entityType":{ "$ref":"#/components/schemas/ImpactedItemTypeEnum" }, "href":{ "type":"string", "description":"The URI for the Impacted Entity Item.", "format":"uri", "readOnly":true }, "specName":{ "type":"string", "description":"The name of the specification.", "readOnly":true }, "technology":{ "type":"string", "description":"The technology of the impacted Connectivity." }, "rateCode":{ "type":"string", "description":"The ratecode of the impacted Connectivity." }, "latitude":{ "format":"double", "type":"number", "description":"The latitude of the impacted location." }, "longitude":{ "format":"double", "type":"number", "description":"The longitude of the impacted location." }, "impactType":{ "type":"string", "description":"Type of the impact, DIRECT or INDIRECT.", "readOnly":true }, "description":{ "type":"string", "description":"A free-text description for the Impacted Entity Item." }, "flowIdentifierDomain":{ "type":"string", "description":"Domain of the impacted flow identifier." }, "flowIdentifierIdentifier":{ "type":"integer", "description":"Identifier of the impacted flow identifier." }, "relatedParty":{ "type":"array", "description":"List of parties related to the impacted entity.", "items":{ "$ref":"#/components/schemas/RelatedPartyRef" } } } }, "ImpactedItemTypeEnum":{ "description":"Entity type of the impacted entity.", "type":"string", "enum":[ "PIPE", "CONNECTIVITY", "SERVICE", "EQUIPMENT", "PHYSICAL DEVICE", "LOGICAL DEVICE", "LOCATION", "NETWORK", "FLOWIDENTIFIER" ] }, "NodeType":{ "type":"string", "description":"Type of the node or subnode.", "enum":[ "PhysicalPort", "PhysicalConnector", "DeviceInterface", "Equipment", "LogicalDevice", "PhysicalDevice" ] }, "ConnectionType":{ "type":"string", "description":"Type of the Connection", "enum":[ "Pipe", "Connectivity" ] }, "NodeLookupRequest":{ "type":"object", "properties":{ "nodeInfo":{ "$ref":"#/components/schemas/NodeInfoRequest" }, "subNodeInfo":{ "$ref":"#/components/schemas/SubNodeInfoRequest" } } }, "SubNodeInfoRequest":{ "type":"object", "properties":{ "type":{ "$ref":"#/components/schemas/NodeType" }, "identifier":{ "type":"string" }, "lookUpFieldOrder":{ "items":{ "type":"string" }, "description":"Order in which the subnode entity lookup should happen.", "example":"[\"name\", \"id\", \"char:someChar\", \"nativeEMSName\"]", "type":"array" } } }, "NodeRequestProperties":{ "type":"object", "description":"Generic node request information.", "properties":{ "name":{ "type":"string", "description":"Name of the node entity." }, "id":{ "type":"string", "description":"Id of the node entity." }, "nativeEMSName":{ "type":"string", "description":"Native EMS Name of the node entity." } } }, "NodeInfoRequest":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/NodeRequestProperties" } ], "properties":{ "type":{ "$ref":"#/components/schemas/NodeType" } } }, "NodeLookupResponse":{ "type":"object", "properties":{ "nodeInfo":{ "$ref":"#/components/schemas/NodeInfoResponse" }, "subNodeInfo":{ "$ref":"#/components/schemas/SubNodeInfoResponse" }, "connections":{ "type":"array", "description":"List of Connectivity / Pipe entity terminated on the subnode.", "items":{ "$ref":"#/components/schemas/ConnectionInfo" } } } }, "NodeInfoResponse":{ "type":"object", "description":"General information about the node in the inventory system.", "allOf":[ { "$ref":"#/components/schemas/NodeResponseProperties" } ], "properties":{ "type":{ "$ref":"#/components/schemas/NodeType" } } }, "SubNodeInfoResponse":{ "type":"object", "description":"General information about the subnode in the inventory system.", "allOf":[ { "$ref":"#/components/schemas/NodeResponseProperties" } ], "properties":{ "type":{ "$ref":"#/components/schemas/NodeType" } } }, "NodeResponseProperties":{ "type":"object", "description":"Generic node response information.", "properties":{ "name":{ "type":"string", "description":"Name of the node entity." }, "id":{ "type":"string", "description":"Id of the node entity." }, "entityId":{ "type":"string", "description":"Entity Id of the node entity." } } }, "ConnectionInfo":{ "type":"object", "description":"General information about the Connectivity / Pipe entity terminated on the subnode.", "properties":{ "connectivityIdentifier":{ "type":"string", "description":"The identifier of the Connectivity." }, "id":{ "type":"string", "description":"The ID of the Pipe / Connectivity." }, "entityId":{ "type":"string", "description":"The Entity ID of the Pipe / Connectivity." }, "name":{ "type":"string", "description":"The name of the Pipe." }, "connectionType":{ "$ref":"#/components/schemas/ConnectionType" }, "href":{ "type":"string", "description":"The inventory system URI of the Connectivity / Pipe.", "format":"uri" }, "specName":{ "type":"string", "description":"The name of the specification." }, "technology":{ "type":"string", "description":"The technology of the Connectivity." }, "rateCode":{ "type":"string", "description":"The ratecode of the Connectivity." } } }, "ConnectionsInfoResponse":{ "type":"object", "properties":{ "connections":{ "type":"array", "description":"List of Connectivity / Pipe entity terminated on the subnode.", "items":{ "$ref":"#/components/schemas/ConnectionInfo" } } } } }, "requestBodies":{ "ResourceReservation":{ "description":"The ResourceReservation to be created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResourceReservation" } } }, "required":true }, "ResourceReservationItemArray":{ "description":"List of ResourceReservation to delete", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResourceReservationItem" } } } }, "required":true }, "EntityResourceReservation":{ "description":"The EntityResourceReservation to be updated", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EntityResourceReservation" } } }, "required":true } }, "parameters":{ "offset":{ "in":"query", "name":"offset", "required":false, "schema":{ "type":"integer", "minimum":0, "default":0 }, "description":"The number of items to skip before starting to collect the result set." }, "limit":{ "in":"query", "name":"limit", "required":false, "schema":{ "type":"integer", "minimum":1, "maximum":10000, "default":200 }, "description":"The number of items to return." }, "fields":{ "in":"query", "required":false, "name":"fields", "schema":{ "type":"string" }, "description":"The fields to include in the response." }, "sort":{ "in":"query", "required":false, "name":"sort", "schema":{ "type":"string" }, "description":"The fields to sort." }, "depth":{ "in":"query", "required":false, "name":"depth", "schema":{ "type":"integer", "minimum":0, "maximum":10, "default":0 }, "description":"The depth of the expansion." }, "expand":{ "in":"query", "required":false, "name":"expand", "schema":{ "type":"string" }, "description":"The additional details to include in the response." }, "quantity":{ "in":"query", "name":"quantity", "required":false, "schema":{ "type":"integer", "minimum":1, "maximum":10000 }, "description":"The number of resources to create." } } } }