Skip to content

Activity Log API (1)

Services to manage Activities in the CDQ Platform

Overview
Krystian Sola

krystian.sola@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/activity-log-api/api-v1/

Production SOAP

https://activity-log-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/soap/v1/

Production

https://activity-log-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/

Activity Log

Search for activities in the CDQ Platform.

Operations

Get all activities

Request

Find all activities

Security
oAuth2
Query
limitinteger

The number of elements to return

Default 20
Example: limit=10
startAfterinteger

The startAfter parameter is used to get the next page of results.

Default 0
Example: startAfter=1
resourceTypeTechnicalKeystring

The Resource Type Technical Key.

Example: resourceTypeTechnicalKey=WORKSPACE
resourceSubTypeTechnicalKeystring

The resource Sub Type Technical Key.

Example: resourceSubTypeTechnicalKey=DATA_QUALITY_PROFILE
resourceIdstring

The Resource Id.

Example: resourceId=1234
whostring

The username or display name of the user who performed the activity. It can be also the client id or the client name

Example: who=Jan Kowalski
workspacestring

The workspace id or workspace name in which the activity happened

Example: workspace=1234
activityTypeTechnicalKeystring

The technicalKey key of the activity type

Example: activityTypeTechnicalKey=CREATED
activityDescriptionstring

The description of the activity

Example: activityDescription=Data Quality Profile created by Jan Kowalski
fromstring(date-time)

The start date of the activity in UTC

Example: from=2021-01-01T00:00:00Z
tostring(date-time)

The end date of the activity in UTC

Example: to=2021-01-01T00:00:00Z
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/activity-log-api/api-v1/activitylogs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(ActivityLog)

List of organization resource quotas.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Get resource types

Request

Find all resource types

Security
oAuth2
Query
limitinteger(int32)>= 1

Number of items to be returned on the page.

Default 100
Example: limit=20
startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Example: startAfter=16
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/activity-log-api/api-v1/activitylogs/resourcestypes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(ActivityLogResourceType)

List of resource types.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}