Jump to

• Request
• Response

View Workflow Configuration Names

get

/api/restapi/workflowInstance/workflowConfiguration

Send a request to this endpoint to view workflow configuration names under the given workspaces.

Request

Query Parameters

• workspaceCodes: string
  Comma separated list of user defined identifiers of workspaces.
• workspaceIds: string
  Comma separated list of system defined identifiers of workspaces.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response will be in the format of two maps: configurationGroupedByWorkspaceId and configurationGroupedByWorkspaceCode. As the name suggests, first field maps the given workspaceIds to list of workflow configuration names present in it and the later one maps the given workspace codes to the list of workflow configuration names present it. For example:
{
"configurationGroupedByWorkspaceId": {
"4001": [
"Configutation 1",
"Configutation 2"
]
},
"configurationGroupedByWorkspaceCode": {
"Workspace Code": [
"Configuration 3",
"Configuration 4"
]
}
}
Projection, pagination & record count will be the supported OOTB features.

Body ()

Root Schema : List<ApiEntityWorkflowConfiguration>

Type: array

Title: List<ApiEntityWorkflowConfiguration>

Show Source

• Array of: object ApiEntityWorkflowConfiguration
  Title: ApiEntityWorkflowConfiguration

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

Nested Schema : ApiEntityWorkflowConfiguration

Type: object

Title: ApiEntityWorkflowConfiguration

Show Source

• configurationGroupedByWorkspaceCode: object configurationGroupedByWorkspaceCode
  Workflow configuration names grouped by workspace code.
• configurationGroupedByWorkspaceId: object configurationGroupedByWorkspaceId
  Workflow configuration names grouped by workspace ID.

{
    "title":"ApiEntityWorkflowConfiguration",
    "type":"object",
    "properties":{
        "configurationGroupedByWorkspaceId":{
            "type":"object",
            "description":"Workflow configuration names grouped by workspace ID.",
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object",
                "description":"PRIMAVERA_DB_DOCUMENT_KEY:WORKFLOW_CONFIG,WS_ID_MAP"
            }
        },
        "configurationGroupedByWorkspaceCode":{
            "type":"object",
            "description":"Workflow configuration names grouped by workspace code.",
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object",
                "description":"PRIMAVERA_DB_DOCUMENT_KEY:WORKFLOW_CONFIG,WS_CODE_MAP"
            }
        }
    },
    "exampleSetFlag":false
}

Nested Schema : configurationGroupedByWorkspaceCode

Type: object

Workflow configuration names grouped by workspace code.

Nested Schema : configurationGroupedByWorkspaceId

Type: object

Workflow configuration names grouped by workspace ID.

204 Response

Successful operation with no content.

400 Response

Invalid Input.

Back to Top