1. REST API for Unified Inventory Management
  2. Tasks
  3. Resource
  4. Flow Identifier

Create a Flow Identifier

post

/flowIdentifier

Creates a flow identifier with the given details.

The following fields are mandatory fields for successful flow identifier creation:

  • @type
  • name
  • resourceSpecification
  • identifier

The created flow identifier will be shown in the response along with the location URL, except when "fields=none" is provided in the request.

Request

Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
A flow identifier.
Match All
A flow identifier.
A flow identifier.
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
The base class for logical resources.
The base class for logical resources.
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
A network address domain.
Match All
A network address domain.
A network address domain.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : RelatedPartyRef
Type: object
A related party, which defines a party or party role linked to a specific entity.
Show Source
Back to Top

Response

Supported Media Types

201 Response

The flow identifier was created successfully.
Body ()
Root Schema : schema
A flow identifier.
Match All
A flow identifier.
A flow identifier.
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
The base class for logical resources.
The base class for logical resources.
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
A network address domain.
Match All
A network address domain.
A network address domain.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : RelatedPartyRef
Type: object
A related party, which defines a party or party role linked to a specific entity.
Show Source

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
  • The error code.
  • Allowed Values: [ "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" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • Allowed Values: [ "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" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • Allowed Values: [ "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" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • Allowed Values: [ "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" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source
Back to Top

Examples

This example shows how to create a flow identifier with the given specification by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X POST "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/flowIdentifier -H 'content-type: application/json' -H credentials -d @ficreate.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.
  • credentials is the base64 encoding of the user ID and password joined by a single colon (ID:password). See "Authentication and Authorization".
  • ficreate.json is the JSON file that specifies the flow identifier to create.

Example of Request Body

This shows an example of the contents of the ficreate.json file sent as the request body. 

{
   "@type": "FlowIdentifier",
   "@baseType": "LogicalResource",
   "name": "IDF_16",
   "resourceSpecification": {
      "id": "Flow_Identifier_Spec",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/Flow_Identifier_Spec",
      "name": "Flow_Identifier_Spec"
   },
   "identifier": 16,
   "resourcePoolName":"IG2"
   "domain": {
      "id": "25-Flow Identifier Domain",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Flow Identifier Domain",
      "@type": "NetworkAddressDomain"
   }
}

Example of Response Body

This example shows the contents of the response body in JSON format. The ID is auto-generated and included in the response, because the input specification indicates auto-generation. 

{
   "id": "28-Flow Identifier Domain#Flow_Identifier_Spec#16",
   "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/28-Flow+Identifier+Domain%23Flow_Identifier_Spec%2316",
   "@type": "FlowIdentifier",
   "@baseType": "LogicalResource",
   "name": "IDF_16",
   "version": "1",
   "lifecycleState": "INSTALLED",
   "lifecycleSubState": "UNASSIGNED",
   "startDate": "2020-01-06T14:00:46.566Z",
   "endDate": "2038-01-19T08:44:07.000Z",
   "resourceSpecification": {
      "id": "Flow_Identifier_Spec",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/Flow_Identifier_Spec",
      "name": "Flow_Identifier_Spec",
      "version": "1",
      "entityType": "FlowIdentifier",
      "startDate": "2019-11-18T00:00:01.000Z",
      "endDate": "2038-01-19T08:44:07.000Z"
   },
   "identifier": 16,
   "resourcePoolName":"IG2"
   "domain": {
      "id": "25-Flow Identifier Domain",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/25-Flow Identifier Domain",
      "@type": "NetworkAddressDomain"
   }
}
Back to Top