Jump to

• Request
• Response

Get a list of all valid business process with only id and name values

get

/business-process-service/service/api/v1/businessprocess/summary

This operation gets all the valid business process with only id and name values using Business Process Service.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : BusinessProcessServiceSummaryCollection

Type: object

Collection of business process summary.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of business process summary.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BusinessProcessServiceSummaryModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object BusinessProcessServiceSummaryModel
  BusinessProcessService Summary Model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BusinessProcessServiceSummaryModel"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : BusinessProcessServiceSummaryModel

Type: object

BusinessProcessService Summary Model

Show Source

• businessProcessDesc: string
  Minimum Length: 0

  Maximum Length: 60

  business Process Description
• businessProcessName: string
  Minimum Length: 0

  Maximum Length: 60

  business Process Name
• businessProductCode(optional): string
  Minimum Length: 0

  Maximum Length: 16

  business Product Code
• lifecycleCode(optional): string
  Minimum Length: 0

  Maximum Length: 20

  Life Cycle Code
• lifecycleDescription(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Life Cycle Description

{
    "description":"BusinessProcessService Summary Model",
    "type":"object",
    "required":[
        "businessProcessName",
        "businessProcessDesc"
    ],
    "properties":{
        "businessProcessName":{
            "description":"business Process Name",
            "type":"string",
            "minLength":0,
            "maxLength":60
        },
        "businessProcessDesc":{
            "description":"business Process Description",
            "type":"string",
            "minLength":0,
            "maxLength":60
        },
        "lifecycleCode":{
            "description":"Life Cycle Code",
            "type":"string",
            "minLength":0,
            "maxLength":20
        },
        "lifecycleDescription":{
            "description":"Life Cycle Description",
            "type":"string",
            "minLength":0,
            "maxLength":105
        },
        "businessProductCode":{
            "description":"business Product Code",
            "type":"string",
            "minLength":0,
            "maxLength":16
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top