Jump to

• Request
• Response
• Examples

Update a Network Address Domain

patch

/networkAddressDomain/{id}

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.

Attribute selection is enabled for all first-level attributes.

Request

Path Parameters

• id(required): string
  The ID of the Network Address Domain to be updated.

Query Parameters

• depth: integer
  The depth of the expansion.

  Default Value: 0
• expand: string
  The additional details to include in the response.
• fields: string
  The fields to include in the response.

Supported Media Types

• application/json-patch+json
• application/merge-patch+json

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

The Network Address Domain to be updated.

Root Schema : schema

Type: array

Show Source

• Array of: object PatchDocument
  A JSON PATCH document.

{
    "type":"array",
    "items":{
        "description":"A list of PATCH documents for a request.",
        "$ref":"#/components/schemas/PatchDocument"
    }
}

Nested Schema : PatchDocument

Type: object

A JSON PATCH document.

Show Source

• op(required): string
  Allowed Values: [ "add", "remove", "replace" ]
• path(required): string
  A JSON pointer indicating where to perform the operation.
• value: object value
  The value to use with the operation.

{
    "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."
        }
    }
}

Nested Schema : value

Type: object

The value to use with the operation.

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

The Network Address Domain to be updated.

Root Schema : schema

A network address domain.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "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"
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

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

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

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

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

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

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

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

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

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

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

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

  The starting date and time when the resource becomes effective.

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

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : type

Type: object

Show Source

• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• name: string
  The name of the network address domain. It also indicates the ID of the domain.
• networkAddressType: string
  The type of network address, either IP Subnet or flow identifier.
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.

{
    "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"
        }
    }
}

Nested Schema : RelatedPartyRef

Type: object

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

Show Source

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The Custom Object was updated successfully.

Body ()

Root Schema : schema

A network address domain.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "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"
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

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

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

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

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

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

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

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

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

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

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

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

  The starting date and time when the resource becomes effective.

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

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : type

Type: object

Show Source

• managedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• name: string
  The name of the network address domain. It also indicates the ID of the domain.
• networkAddressType: string
  The type of network address, either IP Subnet or flow identifier.
• ownedBy: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.

{
    "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"
        }
    }
}

Nested Schema : RelatedPartyRef

Type: object

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

Show Source

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

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

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Type: object

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

Show Source

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

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

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

Nested Schema : message

Type: array

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

Show Source

• Array of: string

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

401 Response

You aren't authorized to make this request.

Body ()

Root Schema : Error

Type: object

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

Show Source

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

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

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

Nested Schema : message

Type: array

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

Show Source

• Array of: string

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

403 Response

The request is forbidden.

Body ()

Root Schema : Error

Type: object

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

Show Source

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

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

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

Nested Schema : message

Type: array

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

Show Source

• Array of: string

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

500 Response

An internal server error occurred.

Body ()

Root Schema : Error

Type: object

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

Show Source

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

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

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

Nested Schema : message

Type: array

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

Show Source

• Array of: string

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

Back to Top

Examples

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

cURL Command

curl -X PATCH "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/networkAddressDomain/ID" -H credentials @nadPatch.json

where:

• hostname is the URL for the UIM REST server.
• port is the port for the UIM REST server.
• version is the version of the API you're using.
• ID is the ID of the network address domain.
• nadPatch.json is the JSON file with updated values.

Example of Request Body

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

Note:

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

{
    "@type": "NetworkAddressDomain",
    "name": "ABC_Inc",
    "description": "Private Domain for ABC_Inc Annexe"
}

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

{
    "op": "replace",
    "path": "/description",
    "value": "Private Domain for ABC_Inc Annexe"
}

Example of Response Body

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

{
   "id": "25-ABC_Inc",
   "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-ABC_Inc",
   "@type": "NetworkAddressDomain",
   "@baseType": "LogicalResource",
   "name": "ABC_Inc",
   "description": "Private Domain for ABC_Inc Annexe",
   "version": "1",
   "resourceSpecification": {
      "id": "PrivateIPAddressDomainSpec",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/PrivateIPAddressDomainSpec",
      "name": "PrivateIPAddressDomainSpec",
      "version": "1",
      "entityType": "NetworkAddressDomain",
      "startDate": "2019-10-16T00:00:01.000Z",
      "endDate": "2038-01-19T08:44:07.000Z"
   },
   "networkAddressType": "IP_SUBNET"
}

Back to Top