Applying for a Data Set

Function

URI

POST /v1/datashare/dataset/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.
provider	Yes	String	Data set publisher identifier.
productID	Yes	String	Data set product ID.
reason	No	String	Reason.
consumerName	No	String	Data set applicant name.

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
consumer	String	Order applicant identifier.
consumerName	String	Order applicant name.
orderSeq	String	Order number.
provider	String	Order provider identifier.
providerName	String	Order provider name.
productID	String	Data set product ID.
productName	String	Data set product name.
price	String	Order amount.
applyTime	String	Application time.
encryptedAesKey	String	Private key.
status	String	Order status.
reason	String	Order application reason.
lockProof	String	Order lock-up proof.
creatorDID	String	DID of the process creator. If there is no process, the value is "".
processID	String	ID of the process of the current order. If there is no process, the value is "".

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",
  "provider" : "did:example:DHkJjyD5wZwya6sd6BNBnG",
  "productID" : "product2",
  "reason" : "apply dataset for AI",
  "consumerName" : "user1"
}

Example Responses

Status code: 200

Order information.

{
  "consumer" : "did:example:3TMWx8owKHARgNwbj4ywmG",
  "consumerName" : "Tyler",
  "orderSeq" : "1",
  "provider" : "did:example:DHkJjyD5wZwya6sd6BNBnG",
  "providerName" : "hw",
  "productID" : "product1",
  "productName" : "prodname1",
  "price" : "0",
  "applyTime" : "1607332359",
  "encryptedAesKey" : "BNGhPwjaTgpM+V7czzw1i4mH21KKN+XLKXHLqVsRIfybUCncqZNfomkRfzX4WEHj+oty1X9oCd4h6xMnRvs8BWE5Tvg6BJ6QTW/km9EO/FSYqzJf2GqQzAleAcLJrTBZ3LRbPaF87CgJ114ae7R+VK9VvfXQ8exuH2KMRD305dXieGpM4VPVv9u1BbL15Jpd/g==",
  "status" : "ready",
  "reason" : "I want product1",
  "lockProof" : ""
}

Status code: 500

Error response.

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

Status Codes

Status Code	Description
200	Order information.
500	Error response.

Error Codes

See Error Codes.

Parent topic: Data Order Management

Previous topic: Data Order Management

Next topic: Authorizing a Data Set

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot