Help Center/ Blockchain Service/ Developer Guide/ Blockchain Middleware APIs/ Trusted Data Exchange (OBT)/ Data Order Management/ Updating Order Status
Updated on 2023-01-18 GMT+08:00
View PDF

Updating Order Status

Function

Updating Order Status

URI

PUT /v1/datashare/dataset/order

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

orgID

Yes

String

Organization ID.

channelID

Yes

String

Channel ID.

cryptoMethod

Yes

String

Encryption method, which is fixed at SW.

cert

Yes

String

Certificate.

sk

Yes

String

Private key.

timestamp

Yes

String

Timestamp.

consumer

Yes

String

Order applicant identifier.

orderSeq

Yes

String

Order number.

orderStatus

Yes

Integer

Order status. 0: completed; 1: failed; 2: canceled.

reason

No

String

Reason.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

result

String

Operation result.

Status code: 500

Table 3 Response body parameters

Parameter

Type

Description

errorCode

String

Error code.

errorMsg

String

Error description.

Example Requests

{
  "orgID" : "ce0ac69b0c8648cd25b44a551780409767c8890b",
  "channelID" : "mychannel",
  "cryptoMethod" : "SW",
  "cert" : "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----",
  "sk" : "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----",
  "timestamp" : "2020-10-27T17:28:16+08:00",
  "consumer" : "did:example:3TMWx8owKHARgNwbj4ywmG",
  "orderSeq" : "1",
  "orderStatus" : 0,
  "reason" : "string"
}

Example Responses

Status code: 200

Operation result.

{
  "result" : "success"
}

Status code: 500

Error response.

{
  "errorCode" : "BCS.5002046",
  "errorMsg" : "Incorrect number of arguments"
}

Status Codes

Status Code

Description

200

Operation result.

500

Error response.

Error Codes

See Error Codes.

Parent topic: Data Order Management