Terms
Idempotent
ToolChain™'s idempotent processing of write requests requires the requester to provide the same set of request parameters according to the interface description. The same set of request parameters will only be executed once in ToolChain™, and repeated requests will be regarded as query operations.
Order status
| Name | Type | Description |
|---|---|---|
| orderStatus | string | INIT，PROCESSING，SUCCESS，FAILURE |
For the idempotent processing of write requests, developers need to use the same set of request parameters to repeat the request until the order status becomes final status. Among them, SUCCESS and FAILURE are the final statuses, and INIT and PROCESSING are the initial statuses. For requests whose final status is FAILURE, developers need to design their own compensation mechanism to ensure the integrity of interface calls. If the final state is SUCCESS, it does not mean that the interface call is successful, it only means that the call is ended. You need to judge whether the call is successful according to the description of the actual calling interface. If the call fails, add an interface compensation mechanism.
Q&A
Q: How to get the appid and appkey of the project
A: Log in to the system with an administrator account, click Developer Center -> Server Application, and copy APPID and APPIKEY. Each account can support up to 10 pairs of appid and appkey
Q: How to get the operator ID
A: Log in to the system with an administrator account, click Console->Staff List in turn, find the corresponding user, click Details, and the account ID is the operator ID.
Q: How to get the DCP Model UUID
A: Log in to the system with an administrator account, click Console->Process Builder, Find the specified process, click Detail -> Version Information -> Detail, find the DCP template that you need, then get the DCP Model UUID.
Q: How to get the DCP Instance UUID
A: Log in to the system with an administrator account, click Console->Project Setting, find the project that needs to upload data, and then clickConfigure->View->Data collection points, find the DCP that needs to upload data, DCP UUID is instance UUID.
Q: How to get the project ID
A: Log in to the system with an administrator account, click Console->Project Setting in turn, find the project that needs to be uploaded, and click Configure to get the ID.
Q: How to get DCP data template
A: Log in to the system with an administrator account, click Console->Project Setting, find the project that needs to upload DCP data, and click Configure->Download
Unzip the file to get all DCP data templates, the file name consists of DCP name and DCP UUID.
Different DCP data has different json data format, and customers need to find the corresponding json data format template and pass in the correct data as required.
| Attribute | Description |
|---|---|
| required | if requried（true, false) |
| min | the minimum value range, for the list, represents the number, for the textbox represents the character length, for the media resource such as pictures, videos, etc. represents the size (byte), for the integer represents value, need to be considered together with the max attribute |
| max | the maximum value range, for the list, represents the number, for the textbox represents the character length, for the media resource such as pictures, videos, etc. represents the size (byte), for the integer represents value, need to be considered together with the min attribute |
| must be | Mandatory assignment |
| default value | default value |
| label | the field name on the front-end page |
Each object in the json data format corresponds to a DCU control. The data types of different DCUs are as follows.
| DCU control | Value type |
|---|---|
| Dropdown | string |
| Boolean | boolean |
| Date | integer(UTC time, accurate to day） |
| Date time | integer(UTC time ,accurate to second) |
| Float | float |
| Integer | integer |
| Long text | string |
| Short text | string |
| List Items | determined by the type of child control |
| Container | determined by the type of child control |
| GPS |
Combination type, including: "country": "//required=false && min=0.0 && max=255.0 && type=String", |
| Audio |
Use the upload resource interface and fill it with the returned result Combination type, including: "filelocation": "//required=true && min=0.0 && max=255.0 && type=String && defaultValue=", |
| File |
Use the upload resource interface and fill it with the returned result Combination type, including: "filelocation": "//required=true && min=0.0 && max=255.0 && type=String && defaultValue=", |
| Image |
Use the upload resource interface and fill it with the returned result Combination type, including: "filelocation": "//required=true && min=0.0 && max=255.0 && type=String && defaultValue=", |
| Video |
Use the upload resource interface and fill it with the returned result Combination type, including: "filelocation": "//required=true && min=0.0 && max=255.0 && type=String && defaultValue=", |
| VID list |
Combination type, including: "num": "//required=false && min=1.0 && max=10000.0 && type=int", |
|
Combination type, including: "emailname": "//required=false && min=0.0 && max=100.0 && type=String && defaultValue= && label=Email Name", |
|
| Website |
Combination type, including: "webpagelink": "//required=false && min=0.0 && max=255.0 && type=String && defaultValue= && label=Web Page Link", |
| DCP reference |
Combination type, including: "datavid": "//required=false && min=66.0 && max=66.0 && type=String", |
Language Type
| Language | Interface language |
|---|---|
| English | en |
| 中文简体 | zh-CN |
| 中文繁体 | zh-HK |
| Deutsch | de |
| 日本語 | ja |
| 한국어 | ko |
| Bahasa Melayu | ms |
| italiano | it-CH |
| français | fr-CH |
| Türkçe | tr |
| Русский | ru |
| ไทย | th |
| العربية | ar |
| עברית | he |
| Bahasa Indonesia | id |
| Português | pt-br |
| Tiếng Việt | vi |
| Español | es |
| Suomi kieli | fi |
Permission introduction
| Permission | Description |
|---|---|
| View | View all project information |
| Update | View all project information and update all user data |
| Operate | View project's own information, create and update own information |
| Admin | All of above |
Comments
0 comments
Please sign in to leave a comment.