Version: 1.0.0
Service Ledger (SL)¶
store¶
POST /get
- Description: Retrieving a value by its key
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| getId | body | Body in JSON |
Responses
200 - The response body for a successful response.
404 - The requested key is not found.
401 - The operation is not allowed.
400 - Invalid request, required parameter(s) missing.
POST /getKeys
- Description: Get all the key of a category
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /put
- Description: Storing a key-value pair
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| putSpec | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed.
400 - Invalid request, required parameter(s) missing.
POST /delete
- Description: Delete a stored key
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed.
400 - Invalid request, required parameter(s) missing.
exec¶
POST /invoke
- Description: invoke the functions in the chaincode
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| invokeSpec | body |
Responses
200 - The response body for a successful chaincode invoke
401 - The operation is not allowed
400 - Invalid request, required parameter(s) missing.
Service Ledger Interface (SLI)¶
dm¶
POST /dm/store
- Description: Storing encryption/tokenization key
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /dm/read
- Description: Retrieving a stored key
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing
POST /dm/delete
- Description: Delete a stored key
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing
monitoring¶
POST /monitoring/store
- Produces: [u’application/json’]
- Description: This endpoint is used to store relevant monitoring data.
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /monitoring/read
- Produces: [u’application/json’]
- Description: This endpoint is used to read the relevant monitoring data.
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
alert¶
POST /alert/store
- Produces: [u’application/json’]
- Description: This endpoint is used to store alerts.
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /alert/read
- Produces: [u’application/json’]
- Description: This endpoint is used to retrieve the stored alert using the index. The body contains the alert id received by the store api
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
state¶
POST /state/vm-store
- Description: Storing federated services
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/member-store
- Description: Storing federated services
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/tenant-create
- Description: Creating a tenant
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/member-read
- Description: Storing federated services
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON cotaining the service id |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/tenant-addMember
- Description: Creating a tenant
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/service-read
- Description: Storing federated services
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON cotaining the service id |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/getKeys
- Description: Get all the key of a category
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/tenant-read
- Description: Storing federated services
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON cotaining the service id |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/vm-read
- Description: Storing federated services
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON cotaining the vm id |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/service-store
- Description: Storing federated services
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /state/deleteKey
- Description: Remove the pair identified by the key
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
policy¶
POST /policy/delete
- Description: Deleting a policy by its id
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| policyId | body | Body in JSON |
Responses
200 - The response body for a successful response.
404 - The respective policy is not found.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing
POST /policy/store
- Description: Storing a new policy
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| policySpec | body | Body in JSON |
Responses
200 - The response body for a successful response.
409 - The operation is not allowed as the policy already exists.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /policy/polService
- Description: Retrieving policies associated to a service
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| serviceId | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing
POST /policy/read
- Description: Retrieving a policy by its id
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| policyId | body | Body in JSON |
Responses
200 - The response body for a successful response.
404 - The requested policy is not found.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing
proposal¶
POST /proposal/getProposal
- Description: getting a proposal
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /proposal/voteProposal
- Description: vote for a submitted a proposal
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /proposal/submitProposal
- Description: Submitting a proposal
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /proposal/countVotes
- Description: Request a votes counting to validate a stored proposal
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
anonymisation¶
POST /anonymisation/register
- Description: This endpoint is used to register a data-sharing event.
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.).
400 - Invalid request, required parameter(s) missing.
POST /anonymisation/queryOldRes
- Description: This endpoint is used to query the anonymised statistical result in Registry given the DataId and requested budget.
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | Body in JSON |
Responses
200 - The response body for a successful response.
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.)
400 - Invalid request, required parameter(s) missing
POST /anonymisation/updateLedger
- Description: this endpoint is used to update final result to Registry
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | JSON body of the received result |
Responses
200 - Success
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.)
400 - Invalid request, required parameter(s) missing
POST /anonymisation/receiveAnonyRes
- Description: this endpoint is used to receive anonymised result from the anonymisation interface
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| body | body | JSON body of the received result |
Responses
200 - Success
401 - The operation is not allowed (unauthorised access, the token is invalid, etc.)
400 - Invalid request, required parameter(s) missing