Jump to

• Request
• Response

View Business Flow Step Messages (Deprecated since 24.2)

get

/api/restapi/pims/flowStepInstanceMessages/{id}

This endpoint returns Gateway business flow step messages that meet the following requirements:

• The object has an ID that matches the value of the {id} path parameter.

Request

Path Parameters

• id(required): integer(int64)
  ID of flow step instance message object.

  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 : FlowStepInstanceMessage

Type: object

Title: FlowStepInstanceMessage

A reference to the flowStepInstMsg business object.

Show Source

• data(required): array data
  The input and output byte data of each step in a flow.
• id(required): integer (int64)
  The unique ID of the flowstep instance message generated by the system.
• messageType: string
  The type of input and output messages of each step in a flow - valid values ZIP or XML
• name(required): string
  The name of the flowstep instance message.
• requestResponseTimestamp(required): string (date-time)
  The time when a request was send or the time when a response was received.
• seqNo(required): integer (int32)
  The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence.
• stringData(required): string
  The input and output messages of each step in a flow.

{
    "title":"FlowStepInstanceMessage",
    "required":[
        "data",
        "id",
        "name",
        "requestResponseTimestamp",
        "seqNo",
        "stringData"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the flowstep instance message.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "type":"integer",
            "description":"The unique ID of the flowstep instance message generated by the system.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "data":{
            "type":"array",
            "description":"The input and output byte data of each step in a flow.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "description":"The input and output byte data of each step in a flow.",
                "format":"byte",
                "xml":{
                    "name":"data"
                },
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "seqNo":{
            "type":"integer",
            "description":"The sequence number of a flowstep instance message. The sequence number determines the display order of the flowstep instance message in a sequence.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "stringData":{
            "type":"string",
            "description":"The input and output messages of each step in a flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "messageType":{
            "type":"string",
            "description":"The type of input and output messages of each step in a flow - valid values ZIP or XML",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "requestResponseTimestamp":{
            "type":"string",
            "description":"The time when a request was send or the time when a response was received.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"A reference to the flowStepInstMsg business object.",
    "xml":{
        "name":"FlowStepInstanceMessage"
    },
    "exampleSetFlag":false
}

Nested Schema : data

Type: array

The input and output byte data of each step in a flow.

Show Source

• Array of: string(byte)
  The input and output byte data of each step in a flow.

{
    "type":"array",
    "description":"The input and output byte data of each step in a flow.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "description":"The input and output byte data of each step in a flow.",
        "format":"byte",
        "xml":{
            "name":"data"
        },
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

404 Response

The requested business flow step messages do not exist, or you do not have access to them.

Back to Top