Jump to

• Request
• Response

View all Gateway Business Flow Loads (Deprecated since 24.2)

get

/api/restapi/pims/flowLoadObjects/list

This endpoint returns all Gateway business flow loads.

Request

Query Parameters

• flowId(required): integer(int64)
  ID of flow object.
  This is a required field.

  Default Value: 0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<FlowLoadObject>

Type: array

Title: List<FlowLoadObject>

Show Source

• Array of: object FlowLoadObject
  Title: FlowLoadObject

  A reference to the flowLoadObject business object.

{
    "title":"List<FlowLoadObject>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/FlowLoadObject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : FlowLoadObject

Type: object

Title: FlowLoadObject

A reference to the flowLoadObject business object.

Show Source

• flowBusinessObject(required): object FlowBusinessObject
  Title: FlowBusinessObject

  A reference to a flow business object.
• id(required): integer (int64)
  The unique ID of the flow load object generated by the system.

{
    "title":"FlowLoadObject",
    "required":[
        "flowBusinessObject",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The unique ID of the flow load object generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "flowBusinessObject":{
            "$ref":"#/components/schemas/FlowBusinessObject",
            "exampleSetFlag":false
        }
    },
    "description":"A reference to the flowLoadObject business object.",
    "xml":{
        "name":"FlowLoadObject"
    },
    "exampleSetFlag":false
}

Nested Schema : FlowBusinessObject

Type: object

Title: FlowBusinessObject

A reference to a flow business object.

Show Source

• businessObject(required): object BusinessObject
  Title: BusinessObject

  A reference to a business object.
• flowDefinition: string
• flowType: string
• id(required): integer (int64)
  The unique ID of the flow business object generated by the system.

{
    "title":"FlowBusinessObject",
    "required":[
        "businessObject",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The unique ID of the flow business object generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "flowType":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "flowDefinition":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "businessObject":{
            "$ref":"#/components/schemas/BusinessObject",
            "exampleSetFlag":false
        }
    },
    "description":"A reference to a flow business object.",
    "xml":{
        "name":"FlowBusinessObject"
    },
    "exampleSetFlag":false
}

Nested Schema : BusinessObject

Type: object

Title: BusinessObject

A reference to a business object.

Show Source

• description(required): string
  A description of the business object.
• id(required): integer (int64)
  The unique ID of the business object generated by the system.
• name(required): string
  The name of the flow business object.

{
    "title":"BusinessObject",
    "required":[
        "description",
        "id",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flow business object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the business object generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "type":"string",
            "description":"A description of the business object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"A reference to a business object.",
    "xml":{
        "name":"BusinessObject"
    },
    "exampleSetFlag":false
}

404 Response

The requested flow load object does not exist, or you do not have access to it.

Back to Top