Skip to content

Credits API (1)

This API provides services for credits enforcement and configuration.

Overview
Krystian Sola

krystian.sola@cdq.com

Languages
Servers
Mock server

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

Production SOAP

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

Production

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

Organization Credits

Credits for an organization.

Operations

Create Organization Credit

Request

Create an organization credit.

Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8
Bodyapplication/json
organizationIdstring(OrganizationId)required

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
creditinteger(Credit)required

The number of credits.

Example: 10
curl -i -X POST \
  https://idp.cdq.com/_mock/apis/credits-api/api-v1/credits/organizations \
  -H 'Authorization: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8' \
  -H 'Content-Type: application/json' \
  -d '{
    "organizationId": "cdq_monitor",
    "credit": 10
  }'

Responses

successful operation

Bodyapplication/json
idstring(OrganizationCreditId)

The ID of the organization credit.

Example: "661fcb85014f2c6c2dba9543"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
creditinteger(Credit)

The number of credits.

Example: 10
usageinteger(Usage)

The number of used credits.

Example: 9
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "661fcb85014f2c6c2dba9543",
  "organizationId": "cdq_monitor",
  "credit": 10,
  "usage": 9,
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444"
}

List Organization Credits

Request

List Organization Credits.

Query
limitinteger(Limit)

Maximum number of entries to return. Used for pagination.

Example: limit=100
startAfterstring(StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652
organizationIdstring(OrganizationId)

ID of the organization.

Example: organizationId=cdq_monitor
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/credits-api/api-v1/credits/organizations \
  -H 'Authorization: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8'

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(OrganizationCredit)
Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Read Organization Credit

Request

Read an organization credit.

Path
creditIdstringrequired

ID of the user to get.

Example: 661fcb85014f2c6c2dba9543
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8
curl -i -X GET \
  https://idp.cdq.com/_mock/apis/credits-api/api-v1/credits/organizations/661fcb85014f2c6c2dba9543 \
  -H 'Authorization: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8'

Responses

successful operation

Bodyapplication/json
idstring(OrganizationCreditId)

The ID of the organization credit.

Example: "661fcb85014f2c6c2dba9543"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
creditinteger(Credit)

The number of credits.

Example: 10
usageinteger(Usage)

The number of used credits.

Example: 9
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "661fcb85014f2c6c2dba9543",
  "organizationId": "cdq_monitor",
  "credit": 10,
  "usage": 9,
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444"
}

Update Organization Credit

Request

Update an organization credit.

Path
creditIdstringrequired

ID of the user to get.

Example: 661fcb85014f2c6c2dba9543
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8
Bodyapplication/json
creditinteger(Credit)required

The number of credits.

Example: 10
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/credits-api/api-v1/credits/organizations/661fcb85014f2c6c2dba9543 \
  -H 'Authorization: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8' \
  -H 'Content-Type: application/json' \
  -d '{
    "credit": 10
  }'

Responses

successful operation

Bodyapplication/json
idstring(OrganizationCreditId)

The ID of the organization credit.

Example: "661fcb85014f2c6c2dba9543"
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
creditinteger(Credit)

The number of credits.

Example: 10
usageinteger(Usage)

The number of used credits.

Example: 9
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedBystring(ModifiedBy)

User or Client UUID which modified the resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "661fcb85014f2c6c2dba9543",
  "organizationId": "cdq_monitor",
  "credit": 10,
  "usage": 9,
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "modifiedBy": "76248934691294444"
}

Delete Organization Credit

Request

Delete an organization credit.

Path
creditIdstringrequired

ID of the user to get.

Example: 661fcb85014f2c6c2dba9543
Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8
curl -i -X DELETE \
  https://idp.cdq.com/_mock/apis/credits-api/api-v1/credits/organizations/661fcb85014f2c6c2dba9543 \
  -H 'Authorization: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8'

Responses

The resource was deleted successfully.

Consume Credit

Request

Consume a credit from an organization.

Headers
Authorizationstringrequired

Authorization header with Bearer Token.

Example: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8
Bodyapplication/json
organizationIdstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
costinteger(Cost)

The amount of credit, which will be consumed.

Example: 1
sourceobject(CostSource)

The source of the cost. Usually it should be capability that has his price.

curl -i -X POST \
  https://idp.cdq.com/_mock/apis/credits-api/api-v1/credits/organizations/consume \
  -H 'Authorization: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqcnVCQzNPbm9FMzdFbWF2QzhoTjQteGRYdUkyZUlGNDM1MDBnalJ5ZHc4In0.eyJleHAiOjE2NDk0MDE4MDMsImlhdCI6MTY0OTM5OTk0MywianRpIjoiMjNiNDNmMjQtOGI4NC00MzcwLTllZTQtNzVhZGNkNjg4M2QzIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay1hZG1pbi5zdGFnaW5nLms4cy5kZXZvcHMuY2RxLWNsb3VkLWVuZ2luZS5jb20vYXV0aC9yZWFsbXMvY3MiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNjUxODVlOWMtMzZjMy00ZmVlLTk3MWQtYzY3ZDVmYzE1ZWRkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiY2xvdWQtYXBwcyIsInNlc3Npb25fc3RhdGUiOiJlNTg5NjlhYi0xM2U1LTQ0MmUtODVkMy1jMDQxOTc2NjRhMDciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwiYnVyZWF1Y3JhdCIsInVtYV9hdXRob3JpemF0aW9uIiwiY2RxX2FkbWluaXN0cmF0b3IiLCJvcmdhbml6YXRpb25hbF9zZXR0aW5nc19hcHBfbWFuYWdlciJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIG9yZ2FuaXphdGlvbiBlbWFpbCIsInNpZCI6ImU1ODk2OWFiLTEzZTUtNDQyZS04NWQzLWMwNDE5NzY2NGEwNyIsIm9yZ2FuaXphdGlvbklkIjoiY2RxIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJvcmdhbml6YXRpb24iOnsibmFtZSI6IkNEUSBTdGFnaW5nIiwiaWQiOiJjZHEifSwibmFtZSI6Im1vbml0b3IiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtb25pdG9yIiwiZmFtaWx5X25hbWUiOiJtb25pdG9yIiwiZW1haWwiOiJtb25pdG9yQGNkcS5jaCIsIndvcmtzcGFjZUlkIjoiNjI0NDJjMzkwZDAxMGEyZGZjMTU1YTg3In0.YSl3yFyQbuwLw-cLe1jqNJzVlUlcBJcz4UwqT40YKWya0-MjEvlVwTSXRkcyRK2Ju6fOB6a2pfvLioKmAJxIy31weIcf3TvSjU0ItlGjzFYHRdlORIUc6w5IJynhHmB5lG1VKcv5IvOR2ZYEdBdTzoD6Xwc1MizX_W0QsYB1rJNuMY2XR0OQ9FjAH8jX8AWaTFbpc6ki58S5mZZ7X_yA6qWyq-1LZSIl4mLrM6JFvvWHMp4TrTdZVBcOLpQ09yv6FYspbNckSZIxWmertBN-VAqtd3Z5nE3w2VPZRtgtNSfw_OTB-SS76ToNnFXl1mC4doMMSpOJbdpRbOLNGVGCNQiagOIdHKTsak49wEp-J-LSWpn7hscuNmzLG4Mg4noCl39oJi1gHdlVBD2P_20N94daFQDo1M8bO0JsdDo9m41_3ZRNDJv4df5v4YxcGXoBoVqbp20lwyNhF1XyiZX49lbsnRzPiq6XeaqmtscTG6ac9-PyP1pwyuViO3r1jOyw3u8XmaNSeEKsebPp-iefQnMnH6gLIAD8Vn3-UwkhONQCXkFbDkqriML7Ti_5xujrIhbA8kk-_ZhHsMXHpulim0n-gLe5VJITi0u1KZVM8WX8WswZOsaVPs0YtcKve2XQMkOxmi87p2yycZ7uEgPAhClFzEZJNU1oXZc1hBOess8' \
  -H 'Content-Type: application/json' \
  -d '{
    "organizationId": "cdq_monitor",
    "cost": 1,
    "source": {
      "technicalKey": "LOOKUP"
    }
  }'

Responses

The credit was consumed and there are enough credits.