Process Template API – VeChain ToolChain® Help Center

Overview

The process template interface can help you query the process template information in the system through interface docking. By adding the corresponding request parameters to the request according to the interface instructions, the system will return the processing results after the call. The request and response are encoded using the UTF-8 character set.

API	Description
v2/process/getProcessList	query process list
v2/process/getProcessDetail	query details of process

Query Process List

POST v2/process/getProcessList

query all processes.

Request Parameters

The interface does not need to construct the body of the request message.

Request Example

{}

Response Example

{
    "code": "common.success",
    "data": {
        "list": [
            {
                "creator": "Vechain",
                "defaultLanguage": "zh-CN",
                "processStatus": "NORMAL",
                "processName": "Food Safety",
                "createTime": 1619614624000,
                "processDescription": "1",
                "processUUID": "15600000-0000-561A-A6430032D612CA4B",
                "processVersion": "V1.0",
                "supportLanguages": [
                    "zh-CN",
                    "en-US"
                ]
            },
            {
                "creator": "Vechain",
                "defaultLanguage": "zh-CN",
                "processStatus": "NORMAL",
                "processName": "General process testing",
                "createTime": 1619076487000,
                "processDescription": "General process testing",
                "processUUID": "15600000-0000-44A9-9CDB0036389A9360",
                "processVersion": "V1.0",
                "supportLanguages": [
                    "en-US"
                ]
            } 
        ]
    }
}

Response Parameters

Name	Type	Description
+ data.list	array (PackageListInfo)	collection of process data information
└ creator	string	process creator
└ defaultLanguage	string []	default language, only support（zh-CN，en-US)
└ processStatus	string	process status（NORMAL/DISABLED)
└ processName	string	process name
└ createTime	Long	create time
└ processDescription	string	process description
└ processUUID	string	process UUID
└ processVersion	string	process version
└ supportLanguages	string []	support language, only support（zh-CN，en-US)

Get Process Detail

POST v2/process/getProcessDetail

Get the details of the specified process, including the basic information of DCP template.

Request Parameters

Name	Type	Required	Description
processUUID	string	Y	process UUID, which is from the response of Get Porcess List api.
processVersion	string	Y	process version, ex:V1.0

Request Example

{
    "processUUID":"15600000-0000-AEF9-530E003B9FC6BCF7",
    "processVersion":"V1.0"
}

Response Example

{
    "code": "common.success",
    "data": {
        "creator": "VeChain Sales&Operation",
        "defaultLanguage": "en-US",
        "processName": "YAK process",
        "processDescription": "Yak process",
        "processUUID": "15600000-0000-AEF9-530E003B9FC6BCF7",
        "processVersion": "V1.0",
        "supportLanguages": [
            "en-US"
        ],
        "dcpDetails": [
            {
                "dcpName": "1. Create Batch",
                "dcpType": "BATCH",
                "dcpDatamodelUUID": "10000900-0623-44d4-a3f9-f68000200001"
            },
            {
                "dcpName": "2. Herders",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000900-f930-440a-b4e0-c79e00200005"
            },
            {
                "dcpName": " 3. Cooperative",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000900-a6e9-4a48-bc54-9ecf00200005"
            },
            {
                "dcpName": "4. Washing",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000900-4c7e-4d10-8c39-bb8f00200005"
            },
            {
                "dcpName": "5. Carding",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000900-172b-48ad-819a-ebc500200005"
            },
            {
                "dcpName": "6. Inspection",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000900-8752-4152-a2d3-5b5400200005"
            },
            {
                "dcpName": "7. Create SKU",
                "dcpType": "SKU",
                "dcpDatamodelUUID": "10000900-c7ef-4615-8b98-af6300200000"
            },
            {
                "dcpName": "8. Decoloring",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000900-8267-4946-97cd-9b4d00200005"
            },
            {
                "dcpName": "9. Transportation-sending",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000900-bd1a-44b6-8003-5acd00200005"
            },
            {
                "dcpName": "10. Binding SKU",
                "dcpType": "BINDSKU",
                "dcpDatamodelUUID": "10000900-2e99-4a22-a579-582e00200002"
            }
        ]
    }
}

响应参数:

参数名	类型	描述
creator	string	process creator
processName	string	process name
processDescription	string	process description
processUUID	string	process UUID
processVersion	string	process version
supportLanguages	string []	support language, only support（zh-CN，en-US)
defaultLanguage	string []	default language, only support（zh-CN，en-US)
+ data.dcpDetails	array DcpDetailModel	collection of the basic DCP data information
└ dcpName	string	DCP name
└ dcpType	string	DCP type
└ dcpDatamodelUUID	string	DCP model UUID

Overview

Query Process List

Get Process Detail

Related articles