Api Invoke Examples

Common

1. response structure

All responses have a common structure like below:

{
  "code": 0,
  "message": "success",
  "data": data
}

Name	Type	Description
code	integer	0: success, other: fail
data	object	data
message	string	error message

2. pagination structure

When querying a list of records, you will get a response with pagination records. Response structure with pagination like below:

{
  "code": 0,
  "message": "success",
  "data": {
    "records": [
      {},
      {}
    ],
    "total": 2,
    "size": 10,
    "current": 1,
    "pages": 1
  }
}

Name	Type	Description
records	array	query result records
total	integer	total number of records
size	integer	page size
current	integer	current page
pages	integer	total number of pages

Get examples

1. document

Request path

GET /v2/label/list

Request parameters

Name	Type	Required	Description	Example
q	string	false	Search condition
current	integer	false	Page number	1
size	integer	false	Number of items per page	10
labelCode	string	false	Label code
labelName	string	false	Label name
labelStatus	integer	false	Label status

2. invoke api

GET https://server.workstem.com/api/v2/label/list?q=01&current=1&size=10

TIP

Empty parameters do not need to be passed.

Post examples

1. document

Request path

POST /v2/label/update

Request parameters

Name	Type	Required	Description
id	string	true	ID
labelCode	string	false	Label code
labelName	string	false	Label name
labelStatus	integer	false	Label status

2. invoke api

POST https://server.workstem.com/api/v2/label/update
{
	"id":"001",
	"labelCode":"C001"
}

TIP

Empty parameters do not need to be passed.