Skip to main content

Project Configuration API

VeChain
  • Updated
Follow

Overview

The project configuration interface can help you operate and query the project configuration 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/createProject Create project
v2/process/copyProject Copy proejct
v2/process/updateProject Update the basic information of proejct
v2/process/getProjectDetail Query details of project
v2/process/getProjectDetailByOperator Query details of project by operator
v2/process/getProjectList Query projects
v2/process/getProjectListByOperator Query projects by operator

  • Create Project

    POST v2/process/createProject

Create Project. The interface has idempotent property, which is determined by the field of requestNo. If the field of requestNo is different, it will be treated as a new request. When orderStatus is FAILURE, developers need to add compensation mechanism. When the orderStatus is SUCCESS, you need to use the projectUUID in the returned result to call query details of project. The projectStatus field in the project details determines whether the call is successful. When the projectStatus field is "NORMAL",  it indicates that the call is successful. Otherwise, the call fails, and a compensation mechanism needs to be added.

Request Parameters

Name Type Required Description
requestNo string Y request number, length is no more than 50, only letters and numbers are allowed
processUUID string Y process UUID, which is from the response of Get Porcess List api.
projectDescription string Y project description
projectName string Y project name

Request Example

{
    "requestNo": "202101011609430400000011",
    "processUUID": "15600000-0000-918D-BE690030EE2B1880",
    "projectDescription": "Food safety, food traceability system",
    "projectName": "Food Traceability"
}

Response Example

{
    "code": "common.success",
    "data": {
        "orderStatus": "SUCCESS",
        "projectUUID": "1563F638-6A12-CC58-E48F-743C25400001"
    }
}

Response Parameters

Name Type Description
orderStatus string request status(INIT,PROCESSING,SUCCESS,FAILURE), for more details, please refer to here
projectUUID string project ID, please refer to here

  • Copy Project

    POST v2/process/copyProject

Copy Project. The interface has idempotent property, which is determined by the field of requestNo. If the field of requestNo is different, it will be treated as a new request. When orderStatus is FAILURE, developers need to add compensation mechanism. When the orderStatus is SUCCESS, you need to use the projectUUID in the returned result to call query details of project. The projectStatus field in the project details determines whether the call is successful. When the projectStatus field is "NORMAL",  it indicates that the call is successful. Otherwise, the call fails, and a compensation mechanism needs to be added.

Request Parameters

Name Type Required Description
requestNo string Y request number, length is no more than 50, only letters and numbers are allowed
sourceProjectUUID string Y source project ID, please refer to here
targetProjectDescription string Y target project description
targetProjectName string Y target project name

Response Example

{
    "requestNo": "202106091609430400000001",
    "sourceProjectUUID": "1563F638-6A12-CC58-E48F-743C25400001",
    "targetProjectDescription": "copy project Desc0001",
    "targetProjectName": "API-Test-CopyProject0001"
}

Response Example

{
    "code": "common.success",
    "data": {
        "orderStatus": "SUCCESS",
        "projectUUID": "156E3079-B6E6-06F6-BC09-C6E464400001"
    }
}

Response Parameters

Name Type Description
orderStatus string request status(INIT,PROCESSING,SUCCESS,FAILURE), for more details, please refer to here
projectUUID string project ID, please refer to here

  • Update Project

    POST v2/process/updateProject

Update the basic information of proejct

Request Parameters

Name Type Required Description

+

changeDataInfo

 object Y project change information
└ projectDescription string N project description
└ projectName string N project name
└ projectStatus string N project status(INIT,PROCESSING,NORMAL,PAUSE,END)
projectUUID string Y project ID

Request Example

{
  "changeDataInfo":
    {
          "projectDescription": "Supply chain process -Change project infomation",
          "projectName": "",
          "projectStatus": "PAUSE"
    },
    "projectUUID": "156DA623-574B-5B40-C9B0-C32944400001"
}

Response Example

{
    "code": "common.success",
    "data": {
        "orderStatus": "SUCCESS"
    }
}

Response Parameters

Name Type Description
orderStatus string request status(INIT,PROCESSING,SUCCESS,FAILURE), for more details, please refer to here

  • Query details of project

    POST v2/process/getProjectDetail

Get project details by project ID.

Request Parameters

Name Type Required Description
projectUUID string Y project UUID, please refer to here

Request Example

{
   "projectUUID": "15671A23-EB55-7A11-78B5-1D8CAE400001"
 }

Response Example

{
    "code": "common.success",
    "data": {
        "projectStatus": "NORMAL",
        "defaultLanguage": "en-US",
        "processName": "Supply traceability in terminal catering stores",
        "createTime": 1611823601000,
        "processUUID": "15600000-0000-918D-BE690030EE2B1880",
        "projectDescription": "Green pepper scrambled eggs",
        "dcpModelList": [
            {
                "dcpInstanceUUID": "10000700-eb70-4094-88e5-3a3101200001",
                "dcpName": "Vegetable garden batch information",
                "dcpType": "BATCH",
                "dcpDatamodelUUID": "10000700-ace4-4cf8-8c33-573900200001"
            },
            {
                "dcpInstanceUUID": "10000700-b03a-45dd-8753-490a01200005",
                "dcpName": "Vegetable garden picking",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-226c-479b-ba2b-7e4a00200005"
            },
            {
                "dcpInstanceUUID": "10000700-3380-4035-80f2-b46201200005",
                "dcpName": "Vegetable garden delivery",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-47ad-4bfb-9eac-801000200005"
            },
            {
                "dcpInstanceUUID": "10000700-9446-483e-84cb-f2ad01200001",
                "dcpName": "Egg batch information",
                "dcpType": "BATCH",
                "dcpDatamodelUUID": "10000700-261c-4b45-a27c-850b00200001"
            },
            {
                "dcpInstanceUUID": "10000700-190d-42d9-9e0e-323601200005",
                "dcpName": "Egg production",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-3515-412c-9557-967f00200005"
            },
            {
                "dcpInstanceUUID": "10000700-6d2a-4d33-816c-f34c01200005",
                "dcpName": "Egg delivery",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-d834-4ded-9490-f74800200005"
            },
            {
                "dcpInstanceUUID": "10000700-28a0-49f2-aa47-10b101200005",
                "dcpName": "Restaurant receipt",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-105a-4757-bb1e-18ef00200005"
            },
            {
                "dcpInstanceUUID": "10000700-c1cc-41fd-bf20-889d01200000",
                "dcpName": "Restaurant menu entry",
                "dcpType": "SKU",
                "dcpDatamodelUUID": "10000700-ed1b-4566-831f-200d00200000"
            },
            {
                "dcpInstanceUUID": "10000700-54d9-4715-9a34-022901200002",
                "dcpName": "Personalized information entry of dishes",
                "dcpType": "BINDSKU",
                "dcpDatamodelUUID": "10000700-ac18-482b-9ed4-0f7a00200002"
            }
        ],
        "processVersion": "V3.0",
        "projectName": "Traceability of Dishes in Terminal Stores",
        "projectUUID": "15671A23-EB55-7A11-78B5-1D8CAE400001",
        "projectVersion": "V3.0"
    }
}

Response Parameters

Name Type Description
projectStatus string project status (INIT,PROCESSING,NORMAL,PAUSE,END)
defaultLanguage string default language
processName string process name
processUUID string process UUID
processVersion string process version
projectName string project name
projectDescription string project description
projectUUID string project UUID, please refer to here
projectVersion string project version
createTime int create time
+ data.dcpModelList array (DataModelsModel) collection of DCP data
└ dcpInstanceUUID string DCP UUID
└ dcpName string DCP name
└ dcpType string DCP type
└ dcpDatamodelUUID string DCP model UUID

  • Query details of project by operator

    POST v2/process/getProjectDetailByOperator

Get project details  by project ID and operator ID.

Request Parameters

Name Type Required Description
projectUUID string Y project UUID, please refer to here
toolchainOperatorUUID string Y operator ID, please refer to here

Request Example

{
   "projectUUID": "15671A23-EB55-7A11-78B5-1D8CAE400001"
   "toolchainOperatorUUID": "0x2cdbcc10a1376a72ad10ae046773e8ec0b1d38e1d1671c1804dcfc82715b8b53"
 }

Response Example

{
    "code": "common.success",
    "data": {
        "projectStatus": "NORMAL",
        "defaultLanguage": "en-US",
        "processName": "Supply traceability in terminal catering stores",
        "createTime": 1611823601000,
        "processUUID": "15600000-0000-918D-BE690030EE2B1880",
        "projectDescription": "Green pepper scrambled eggs",
        "dcpModelList": [
            {
                "dcpInstanceUUID": "10000700-eb70-4094-88e5-3a3101200001",
                "dcpName": "Vegetable garden batch information",
                "dcpType": "BATCH",
                "dcpDatamodelUUID": "10000700-ace4-4cf8-8c33-573900200001"
            },
            {
                "dcpInstanceUUID": "10000700-b03a-45dd-8753-490a01200005",
                "dcpName": "Vegetable garden picking",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-226c-479b-ba2b-7e4a00200005"
            },
            {
                "dcpInstanceUUID": "10000700-3380-4035-80f2-b46201200005",
                "dcpName": "Vegetable garden delivery",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-47ad-4bfb-9eac-801000200005"
            },
            {
                "dcpInstanceUUID": "10000700-9446-483e-84cb-f2ad01200001",
                "dcpName": "Egg batch information",
                "dcpType": "BATCH",
                "dcpDatamodelUUID": "10000700-261c-4b45-a27c-850b00200001"
            },
            {
                "dcpInstanceUUID": "10000700-190d-42d9-9e0e-323601200005",
                "dcpName": "Egg production",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-3515-412c-9557-967f00200005"
            },
            {
                "dcpInstanceUUID": "10000700-6d2a-4d33-816c-f34c01200005",
                "dcpName": "Egg delivery",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-d834-4ded-9490-f74800200005"
            },
            {
                "dcpInstanceUUID": "10000700-28a0-49f2-aa47-10b101200005",
                "dcpName": "Restaurant receipt",
                "dcpType": "DATAPOINT",
                "dcpDatamodelUUID": "10000700-105a-4757-bb1e-18ef00200005"
            },
            {
                "dcpInstanceUUID": "10000700-c1cc-41fd-bf20-889d01200000",
                "dcpName": "Restaurant menu entry",
                "dcpType": "SKU",
                "dcpDatamodelUUID": "10000700-ed1b-4566-831f-200d00200000"
            },
            {
                "dcpInstanceUUID": "10000700-54d9-4715-9a34-022901200002",
                "dcpName": "Personalized information entry of dishes",
                "dcpType": "BINDSKU",
                "dcpDatamodelUUID": "10000700-ac18-482b-9ed4-0f7a00200002"
            }
        ],
        "processVersion": "V3.0",
        "projectName": "Traceability of Dishes in Terminal Stores",
        "projectUUID": "15671A23-EB55-7A11-78B5-1D8CAE400001",
        "projectVersion": "V3.0"
    }
}

Response Parameters

Name Type Description
projectStatus string project status (INIT,PROCESSING,NORMAL,PAUSE,END)
defaultLanguage string default language
processName string process name
processUUID string process UUID
processVersion string process version
projectName string project name
projectDescription string project description
projectUUID string project UUID, please refer to here
projectVersion string project version
createTime int create time
+ data.dcpModelList array (DataModelsModel) collection of DCP data
└ dcpInstanceUUID string DCP UUID
└ dcpName string DCP name
└ dcpType string DCP type
└ dcpDatamodelUUID string DCP model UUID

  • Query projects

    POST v2/process/getProjectList

Query projects，support project status and key words of project name.

Request Parameters

Name Type Required Description
projectNameKeywords string N key words of project name
projectStatus string N project status (INIT,PROCESSING,NORMAL,PAUSE,END)
page int Y page number, ex: page 3
size int Y row number displayed per page, up to 100
startTime long N filter the start time of project based on the UTC time (accurate to milliseconds) of the create time
endTime long N filter the end time of project based on the UTC time (accurate to milliseconds) of the create time

Request Example

{
    "projectNameKeywords": "",
    "projectStatus": "",
    "page": 1,
    "size": 3
}

Response Example

{
    "code": "common.success",
    "data": {
        "exist": true,
        "size": 3,
        "page": 1,
        "rows": 112,
        "list": [
            {
                "projectStatus": "NORMAL",
                "defaultLanguage": "zh-CN",
                "processName": "General Traceability Process",
                "createTime": 1581479178000,
                "processUUID": "15600000-0000-9BFB-A827-003C39618DBF",
                "projectDescription": "",
                "projectName": "test1",
                "processVersion": "V1.0",
                "buUUID": "15600000-0000-AC3A-149D-001E1C9F8114",
                "buName": "Vechain",
                "projectUUID": "15600000-0000-CAEB-6AA9-002C583F83FC",
                "projectVersion": "V1.0"
            },
            {
                "projectStatus": "NORMAL",
                "defaultLanguage": "zh-CN",
                "processName": "General Traceability Process",
                "createTime": 1582259674000,
                "processUUID": "15600000-0000-9BFB-A827-003C39618DBF",
                "projectDescription": "",
                "projectName": "test0221",
                "processVersion": "V1.0",
                "buUUID": "15600000-0000-AC3A-149D-001E1C9F8114",
                "buName": "Vechain",
                "projectUUID": "15600000-0000-92EC-215A-0025E6F74D00",
                "projectVersion": "V1.0"
            },
            {
                "projectStatus": "NORMAL",
                "defaultLanguage": "zh-CN",
                "processName": "General Traceability Process",
                "createTime": 1582948635000,
                "processUUID": "15600000-0000-9BFB-A827-003C39618DBF",
                "projectDescription": "",
                "projectName": "Food traceability",
                "processVersion": "V1.0",
                "buUUID": "15600000-0000-AC3A-149D-001E1C9F8114",
                "buName": "Vehcain",
                "projectUUID": "15600000-0000-0957-5CBC-002C4E2798C5",
                "projectVersion": "V1.0"
            }
        ]
    }
}

Response Parameters

Name Type Description
exist boolean if data exist
size int row number displayed per page
page int page number
rows int total rows
+ data.list

array 

（ProjectListInfo）

 collection of project information
└ processName string process name
└ processUUID string process UUID
└ processVersion string process version
└ buUUID string BU UUID
└ buName string BU name
└ projectName string project name
└ projectUUID string project UUID, please refer to here
└ projectVersion string project version
└ projectStatus string project status (INIT,PROCESSING,NORMAL,PAUSE,END)
└ defaultLanguage string project default language
└ projectDescription string project description
└ createTime long create time

  • Query projects by operator

    POST v2/process/getProjectListByOperator

Query projects by operator, support project status and key words of project name.

Request Parameters

Name Type Required Description
projectNameKeywords string N key words of project name
projectStatus string N project status (INIT,PROCESSING,NORMAL,PAUSE,END)
page int Y page number, ex: page 3
size int Y row number displayed per page, up to 100
startTime long N filter the start time of project based on the UTC time (accurate to milliseconds) of the create time
endTime long N filter the end time of project based on the UTC time (accurate to milliseconds) of the create time
toolchainOperatorUUID string Y operator ID, please refer to here

Request Example

{
    "projectNameKeywords": "",
    "projectStatus": "",
    "page": 1,
    "size": 1,
    "toolchainOperatorUUID": "0x871d74954d487c16ec9d208244756f9c4ea3a96559fb731304d1555e8ff9655a"
}

Response Example

{
    "code": "common.success",
    "data": {
        "exist": true,
        "size": 1,
        "page": 1,
        "rows": 2,
        "list": [
            {
                "projectStatus": "NORMAL",
                "defaultLanguage": "zh-CN",
                "processName": "General Traceability Process",
                "createTime": 1616148003000,
                "processUUID": "15600000-0000-9BFB-A827-003C39618DBF",
                "projectDescription": "TestProjectdesc",
                "projectName": "TestProjectDemo",
                "processVersion": "V1.0",
                "buUUID": "15600000-0000-AC3A-149D-001E1C9F8114",
                "buName": "Vechain",
                "projectUUID": "156AA5CC-EDE8-107D-6B4E-B78ED1400001",
                "projectVersion": "V1.0"
            }
        ]
    }
}

Response Parameters

Name Type Description
exist boolean if data exist
size int row number displayed per page
page int page number
rows int total rows
+ data.list

array 

（ProjectListInfo）

 collection of project information
└ processName string process name
└ processUUID string process UUID
└ processVersion string process version
└ buUUID string BU UUID
└ buName string BU name
└ projectName string project name
└ projectUUID string project UUID, please refer to here
└ projectVersion string project version
└ projectStatus string project status (INIT,PROCESSING,NORMAL,PAUSE,END)
└ defaultLanguage string project default language
└ projectDescription string project description
└ createTime long create time

Related articles

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk