Sharing a Data Set

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.

provider

Yes

String

Data publisher identifier.

providerName

No

String

Data publisher name.

productName

Yes

String

Product name.

productID

Yes

String

Product ID.

sampleUrl

Yes

String

Sample data storage location.

sampleSize

No

String

Sample data size.

sampleType

No

String

Sample data type.

sampleName

No

String

Sample data name.

fileType

No

String

Data file type.

dataUrl

Yes

String

Data storage location.

dataHash

No

String

Data hash value.

dataSize

No

String

Data size.

dataName

No

String

Data name.

description

No

String

Data set description. When using ABE for encryption, describe the encryption policy in detail.

plainData

Yes

String

Plaintext of the Base64-encoded data.

consumer

Yes

String

Order applicant identifier.

orderSeq

No

String

Order number. If this parameter is left empty, the value is generated randomly.

watermarkType

No

String

Watermark type, which can be visible or blind. Specify this parameter if you want to embed a watermark. The embedded watermark is in the format of Publisher DID_Product ID.

file

No

String

File to embed a watermark in. If the file has a watermark, the plainData parameter does not take effect.

productIDKeywords

No

Array of productIDKeywordsJson objects

Index keyword contained in the product ID, which is in JSON and is used for querying orders by condition.

onChainStore

No

String

Whether to store ciphertext data on the chain. The value can be true or false (default). If this parameter is set to true, sampleUrl and dataUrl will be automatically set. Watermarking is not supported when chain storage is used.

consumerName

No

String

Name of the user.

creatorDID

No

String

DID of the creator of the data set sharing process. This parameter does not need to be set when action is set to new.

processID

No

String

ID of the data set sharing process. This parameter does not need to be set when action is set to new.

stageName

No

String

Name of the data set sharing stage.

action

No

String

Process action. The options are new, append, and "" (N/A). If this parameter is not set, the value is regarded as N/A.

category

No

String

Encryption type, which can be symmetric (default) or abe. If abe is used, specify policy.

policy

No

policy object

ABE policy.

value

No

String

Keyword value.

Threshold

Yes

Integer

Attribute threshold that a policy must meet.

Children

Yes

Array of policy-children objects

Sub-attribute list.

name

Yes

String

Attribute name.

type

Yes

String

Attribute type (plain, comparable, or policy.)

value

Yes

policy-children-comparablevalue object

Attribute value, which is determined based on the attribute type. When the attribute type is plain, the value is a string. When the attribute type is policy, the value is a sub-policy. When the attribute type is comparable, the value contains op, value, and maxValue.

op

No

String

Comparison operator (>, <, or =). This parameter is mandatory when type is set to comparable.

value

Yes

String

Attribute value of the comparison type. The value must be an integer.

maxValue

No

String

Upper limit of value. This parameter is mandatory when the attribute type is comparable.

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 "".

encryptData

String

Ciphertext of the Base64-encoded data.

errorCode

String

Error code.

errorMsg

String

Error description.

200

Order information.

500

Error response.