Skip to content
/AppLog

ClickWrap Integrators API (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

http://localhost/

AppLog

Manage appLogs

Operations

Create a new appLog

Request

Headers
apiKeystringrequired
Bodyapplication/json

The content of the appLog to create

applicationGuidstring(uuid)required

The guid of the application to log to

Example: "dd1d816d-2e80-478c-93fa-6cf29b168de1"
ownerstringnon-emptyrequired
Example: "My owner"
scopestringnon-emptyrequired
Example: "My scope"
sourcestringnon-emptyrequired
Example: "My source"
targetstringnon-emptyrequired
Example: "My target"
payloadstringnon-emptyrequired
Example: "My payload"
curl -i -X POST \
  http://localhost/api/AppLog \
  -H 'Content-Type: application/json' \
  -H 'apiKey: string' \
  -d '{
    "applicationGuid": "dd1d816d-2e80-478c-93fa-6cf29b168de1",
    "owner": "My owner",
    "scope": "My scope",
    "source": "My source",
    "target": "My target",
    "payload": "My payload"
  }'

Responses

Created

Bodyapplication/json
guidstring(uuid)
applicationGuidstring(uuid)
ownerstring or null
timeStampstring(date-time)
scopestring or null
sourcestring or null
ipstring or null
targetstring or null
hashstring or null
payloadstring or null
Response
application/json
{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "applicationGuid": "605b7987-e677-4f32-bd9d-456466d64341",
  "owner": "string",
  "timeStamp": "2019-08-24T14:15:22Z",
  "scope": "string",
  "source": "string",
  "ip": "string",
  "target": "string",
  "hash": "string",
  "payload": "string"
}

Provides a filtered list of appLogs

Request

Headers
apiKeystringrequired
Bodyapplication/json

The parameters to filter by

applicationGuidstring(uuid)
dateFromstring or null(date-time)
Example: "2020/04/01"
dateTostring or null(date-time)
Example: "2030/04/01"
pageinteger(int32)[ 0 .. 2147483647 ]
Example: 0
itemsPerPageinteger(int32)[ 1 .. 5000 ]
Example: 20
curl -i -X POST \
  http://localhost/api/AppLog/List \
  -H 'Content-Type: application/json' \
  -H 'apiKey: string' \
  -d '{
    "applicationGuid": "605b7987-e677-4f32-bd9d-456466d64341",
    "dateFrom": "2020/04/01",
    "dateTo": "2030/04/01",
    "page": 0,
    "itemsPerPage": 20
  }'

Responses

Success

Bodyapplication/jsonArray [
guidstring(uuid)
applicationGuidstring(uuid)
ownerstring or null
timeStampstring(date-time)
scopestring or null
sourcestring or null
ipstring or null
targetstring or null
payloadstring or null
blockchainStatusinteger(int32)(ConsentStatusEnum)
Enum012345678
blockchainStatusDatestring(date-time)
blockchainProcessIdstring or null
blockchainUuidstring or null
hashstring or null
blockchainTxHashUrlstring or null
]
Response
application/json
[
  {
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "applicationGuid": "605b7987-e677-4f32-bd9d-456466d64341",
    "owner": "string",
    "timeStamp": "2019-08-24T14:15:22Z",
    "scope": "string",
    "source": "string",
    "ip": "string",
    "target": "string",
    "payload": "string",
    "blockchainStatus": 0,
    "blockchainStatusDate": "2019-08-24T14:15:22Z",
    "blockchainProcessId": "string",
    "blockchainUuid": "string",
    "hash": "string",
    "blockchainTxHashUrl": "string"
  }
]

Provides the audit trail pdf document for a specific appLog

Request

Path
guidstring(uuid)required

The guid of the appLog

Headers
apiKeystringrequired
curl -i -X GET \
  'http://localhost/api/AppLog/GetAuditTrail/{guid}' \
  -H 'apiKey: string'

Responses

Success

Bodyapplication/pdf
string(binary)

SignedContract

Manage signedContracts

Operations