Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

Governance

This page outlines the operations, endpoints, parameters, and example requests and responses for the Governance.

GET /api/v2/approvalPolicies/

List Approval Policies.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/approvalPolicies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
entityType query string false Type of entity to filter policies by.
namePart query string false Part of the policy name to search by.

Enumerated Values

Parameter Value
entityType [deployment, Deployment, DEPLOYMENT, deploymentModel, DeploymentModel, DEPLOYMENT_MODEL, deploymentConfig, DeploymentConfig, DEPLOYMENT_CONFIG, deploymentStatus, DeploymentStatus, DEPLOYMENT_STATUS, deploymentMonitoringData, DeploymentMonitoringData, DEPLOYMENT_MONITORING_DATA]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "active": true,
      "automaticAction": {
        "action": "cancel",
        "period": "string"
      },
      "id": "string",
      "name": "string",
      "openRequests": 0,
      "review": {
        "groups": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "reminderPeriod": "string"
      },
      "trigger": {
        "entityType": "deployment",
        "filterGroups": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "intendedAction": {
          "action": "create",
          "condition": {
            "condition": "equals",
            "fieldName": "string",
            "values": [
              "string"
            ]
          }
        },
        "labels": {
          "groupLabel": "string",
          "label": "string"
        }
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Approval Policy has been successfully updated. ApprovalPolicyListResponse
403 Forbidden Approval Policy management feature is disabled for the user. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/approvalPolicies/

Create a new Approval Policy.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/approvalPolicies/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "active": true,
  "automaticAction": {
    "action": "cancel",
    "period": "string"
  },
  "name": "string",
  "review": {
    "groups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "reminderPeriod": "string"
  },
  "trigger": {
    "entityType": "deployment",
    "filterGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "intendedAction": {
      "action": "create",
      "condition": {
        "condition": "equals",
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    },
    "labels": {
      "groupLabel": "string",
      "label": "string"
    }
  }
}

Parameters

Name In Type Required Description
body body ApprovalPolicy false none

Example responses

201 Response

{
  "active": true,
  "automaticAction": {
    "action": "cancel",
    "period": "string"
  },
  "id": "string",
  "name": "string",
  "openRequests": 0,
  "review": {
    "groups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "reminderPeriod": "string"
  },
  "trigger": {
    "entityType": "deployment",
    "filterGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "intendedAction": {
      "action": "create",
      "condition": {
        "condition": "equals",
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    },
    "labels": {
      "groupLabel": "string",
      "label": "string"
    }
  }
}

Responses

Status Meaning Description Schema
201 Created Approval Policy has been successfully created. ApprovalPolicyResponse
403 Forbidden Approval Policy management feature is disabled for the user. None
422 Unprocessable Entity Approval Policy could not be created with the given input. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/approvalPolicies/{approvalPolicyId}/

Delete the policy with the given ID.

Code samples

# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/approvalPolicies/{approvalPolicyId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
approvalPolicyId path string true ID of the Approval Policy.

Responses

Status Meaning Description Schema
204 No Content Approval Policy has been successfully deleted. None
403 Forbidden Approval Policy management feature is disabled for the user. None
404 Not Found Approval Policy does not exist or the user doesn't have access to it. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/approvalPolicies/{approvalPolicyId}/

Retrieve the policy with the given ID.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/approvalPolicies/{approvalPolicyId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
approvalPolicyId path string true ID of the Approval Policy.

Example responses

200 Response

{
  "active": true,
  "automaticAction": {
    "action": "cancel",
    "period": "string"
  },
  "id": "string",
  "name": "string",
  "openRequests": 0,
  "review": {
    "groups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "reminderPeriod": "string"
  },
  "trigger": {
    "entityType": "deployment",
    "filterGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "intendedAction": {
      "action": "create",
      "condition": {
        "condition": "equals",
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    },
    "labels": {
      "groupLabel": "string",
      "label": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Approval Policy has been successfully retrieved. ApprovalPolicyResponse
403 Forbidden Approval Policy management feature is disabled for the user. None
404 Not Found Approval Policy does not exist or the user doesn't have access to it. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/approvalPolicies/{approvalPolicyId}/

Update the policy with the given ID.

Code samples

# You can also use wget
curl -X PUT https://app.datarobot.com/api/v2/approvalPolicies/{approvalPolicyId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "active": true,
  "automaticAction": {
    "action": "cancel",
    "period": "string"
  },
  "name": "string",
  "review": {
    "groups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "reminderPeriod": "string"
  },
  "trigger": {
    "entityType": "deployment",
    "filterGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "intendedAction": {
      "action": "create",
      "condition": {
        "condition": "equals",
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    },
    "labels": {
      "groupLabel": "string",
      "label": "string"
    }
  }
}

Parameters

Name In Type Required Description
approvalPolicyId path string true ID of the Approval Policy.
body body ApprovalPolicy false none

Example responses

200 Response

{
  "active": true,
  "automaticAction": {
    "action": "cancel",
    "period": "string"
  },
  "id": "string",
  "name": "string",
  "openRequests": 0,
  "review": {
    "groups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "reminderPeriod": "string"
  },
  "trigger": {
    "entityType": "deployment",
    "filterGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "intendedAction": {
      "action": "create",
      "condition": {
        "condition": "equals",
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    },
    "labels": {
      "groupLabel": "string",
      "label": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Approval Policy has been successfully updated. ApprovalPolicyResponse
403 Forbidden Approval Policy management feature is disabled for the user. None
404 Not Found Approval Policy does not exist or the user doesn't have access to it. None
422 Unprocessable Entity Approval Policy could not be created with the given input. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/approvalPolicies/{approvalPolicyId}/shareableChangeRequests/

Get information about Change Requests submitted for a certain Approval Policy.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/approvalPolicies/{approvalPolicyId}/shareableChangeRequests/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
orderBy query string false Attribute to order Change Requests by.
approvalPolicyId path string true ID of the Approval Policy.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "changeRequestId": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "entityId": "string",
      "entityName": "string",
      "requester": "string",
      "state": "OPENED",
      "updateDate": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Change Requests information has been successfully retrieved. ChangeRequestInfoListResponse
403 Forbidden Approval Policy management feature is disabled for the user. None
404 Not Found Approval Policy does not exist or the user doesn't have access to it. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/approvalPolicyMatch/

Get policy ID matching the query

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/approvalPolicyMatch/?entityType=deployment&action=create \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
entityType query string true Searched typed of the entity.
action query string true Searched policy action.
fieldName query string false Name of the entity field to filter policies by.
fieldValue query string false Value of the entity field to filter policies by.

Enumerated Values

Parameter Value
entityType [deployment, Deployment, DEPLOYMENT, deploymentModel, DeploymentModel, DEPLOYMENT_MODEL, deploymentConfig, DeploymentConfig, DEPLOYMENT_CONFIG, deploymentStatus, DeploymentStatus, DEPLOYMENT_STATUS, deploymentMonitoringData, DeploymentMonitoringData, DEPLOYMENT_MONITORING_DATA]
action [create, Create, CREATE, update, Update, UPDATE, delete, Delete, DELETE]

Example responses

200 Response

{
  "action": "create",
  "entityType": "deployment",
  "fieldName": "string",
  "fieldValue": "string",
  "policyId": "string"
}

Responses

Status Meaning Description Schema
200 OK Search executed successfully. ApprovalPolicyMatchResponse
403 Forbidden Approval Policy management feature is disabled for the user. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/approvalPolicyTriggers/

Get a list of available policy triggers.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/approvalPolicyTriggers/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Example responses

200 Response

{
  "data": [
    {
      "entityType": "deployment",
      "filterGroups": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "intendedAction": {
        "action": "create",
        "condition": {
          "condition": "equals",
          "fieldName": "string",
          "values": [
            "string"
          ]
        }
      },
      "labels": {
        "groupLabel": "string",
        "label": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The list of triggers is successfully generated. ApprovalWorkflowListTriggerResponse
403 Forbidden Approval Policy management feature is disabled for the user. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/changeRequests/

List all Change Requests accessible by the user for the given product entity type.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/changeRequests/?entityType=deployment \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
entityType query string true Type of the entity to filter requests by.
entityId query any false ID of the entity to filter change requests by.
myRequests query string false Filter change requests by the owner. If true, only returns change requests owned by the user. If false, only returns change requests owned by other users but accessible to the requester.
showApproved query string false Filter change requests by status. If true, only returns approved change requests. If false, only returns not approved change requests.
showCancelled query string false Filter change requests by status. If true, only returns cancelled change requests. If false, only returns not cancelled change requests.
status query any false Filter change requests by status.
orderBy query string false The order that the results should be retrieved in.

Enumerated Values

Parameter Value
entityType [deployment, Deployment, DEPLOYMENT]
myRequests [false, False, true, True]
showApproved [false, False, true, True]
showCancelled [false, False, true, True]
orderBy [createdAt, -createdAt, processedAt, -processedAt, updatedAt, -updatedAt]

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "action": "approve",
      "autoApply": false,
      "change": {
        "approvalStatus": "APPROVED"
      },
      "changeVersionId": "string",
      "comment": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "diff": {
        "changesFrom": [
          "string"
        ],
        "changesTo": [
          "string"
        ]
      },
      "entityId": "string",
      "entityType": "deployment",
      "id": "string",
      "numApprovalsRequired": 0,
      "processedAt": "2019-08-24T14:15:22Z",
      "status": "pending",
      "statusChangedAt": "2019-08-24T14:15:22Z",
      "statusChangedBy": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userId": "string",
      "userName": "string",
      "userOperations": {
        "canCancel": true,
        "canComment": true,
        "canResolve": true,
        "canReview": true,
        "canUpdate": true
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
201 Created none ChangeRequestsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/changeRequests/

Request changes for a supported product entity. For now, you can request changes for deployments only.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/changeRequests/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "action": "approve",
  "autoApply": false,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "comment": "string",
  "entityId": "string",
  "entityType": "deployment"
}

Parameters

Name In Type Required Description
body body ChangeRequestCreate false none

Example responses

201 Response

{
  "action": "approve",
  "autoApply": false,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "changeVersionId": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "diff": {
    "changesFrom": [
      "string"
    ],
    "changesTo": [
      "string"
    ]
  },
  "entityId": "string",
  "entityType": "deployment",
  "id": "string",
  "numApprovalsRequired": 0,
  "processedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "statusChangedAt": "2019-08-24T14:15:22Z",
  "statusChangedBy": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": "string",
  "userName": "string",
  "userOperations": {
    "canCancel": true,
    "canComment": true,
    "canResolve": true,
    "canReview": true,
    "canUpdate": true
  }
}

Responses

Status Meaning Description Schema
201 Created Change Request Created. ChangeRequestResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/changeRequests/{changeRequestId}/

Retrieve Change Request by ID.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/changeRequests/{changeRequestId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
changeRequestId path string true ID of the Change Request.

Example responses

200 Response

{
  "action": "approve",
  "autoApply": false,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "changeVersionId": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "diff": {
    "changesFrom": [
      "string"
    ],
    "changesTo": [
      "string"
    ]
  },
  "entityId": "string",
  "entityType": "deployment",
  "id": "string",
  "numApprovalsRequired": 0,
  "processedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "statusChangedAt": "2019-08-24T14:15:22Z",
  "statusChangedBy": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": "string",
  "userName": "string",
  "userOperations": {
    "canCancel": true,
    "canComment": true,
    "canResolve": true,
    "canReview": true,
    "canUpdate": true
  }
}

Responses

Status Meaning Description Schema
200 OK none ChangeRequestResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/changeRequests/{changeRequestId}/

Update Change Request with the given ID.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/changeRequests/{changeRequestId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "autoApply": true,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "comment": "string"
}

Parameters

Name In Type Required Description
changeRequestId path string true ID of the Change Request.
body body ChangeRequestUpdate false none

Example responses

200 Response

{
  "action": "approve",
  "autoApply": false,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "changeVersionId": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "diff": {
    "changesFrom": [
      "string"
    ],
    "changesTo": [
      "string"
    ]
  },
  "entityId": "string",
  "entityType": "deployment",
  "id": "string",
  "numApprovalsRequired": 0,
  "processedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "statusChangedAt": "2019-08-24T14:15:22Z",
  "statusChangedBy": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": "string",
  "userName": "string",
  "userOperations": {
    "canCancel": true,
    "canComment": true,
    "canResolve": true,
    "canReview": true,
    "canUpdate": true
  }
}

Responses

Status Meaning Description Schema
200 OK none ChangeRequestResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/changeRequests/{changeRequestId}/reviews/

List Change Request reviews.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/changeRequests/{changeRequestId}/reviews/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
status query string false Review status to filter by.
changeVersionId query string false ID of the change version to filter by
changeRequestId path string true ID of the Change Request.

Enumerated Values

Parameter Value
status [approved, Approved, APPROVED, changesRequested, ChangesRequested, CHANGES_REQUESTED, commented, Commented, COMMENTED]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "changeRequestId": "string",
      "changeVersionId": "string",
      "comment": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "status": "approved",
      "userId": "string",
      "userName": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ReviewsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/changeRequests/{changeRequestId}/reviews/

Review the Change Request.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/changeRequests/{changeRequestId}/reviews/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "changeVersionId": "string",
  "comment": "string",
  "status": "approved"
}

Parameters

Name In Type Required Description
changeRequestId path string true ID of the Change Request.
body body ReviewCreate false none

Example responses

201 Response

{
  "changeRequestId": "string",
  "changeVersionId": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "status": "approved",
  "userId": "string",
  "userName": "string"
}

Responses

Status Meaning Description Schema
201 Created none ReviewResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/changeRequests/{changeRequestId}/reviews/{reviewId}/

Retrieve a review by ID.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/changeRequests/{changeRequestId}/reviews/{reviewId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
changeRequestId path string true ID of the Change Request.
reviewId path string true ID of the review.

Example responses

200 Response

{
  "changeRequestId": "string",
  "changeVersionId": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "status": "approved",
  "userId": "string",
  "userName": "string"
}

Responses

Status Meaning Description Schema
200 OK none ReviewResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/changeRequests/{changeRequestId}/status/

Resolve or Cancel the Change Request.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/changeRequests/{changeRequestId}/status/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Body parameter

{
  "status": "cancelled"
}

Parameters

Name In Type Required Description
changeRequestId path string true ID of the Change Request.
body body ChangeRequestUpdateStatus false none

Example responses

200 Response

{
  "status": "cancelled"
}

Responses

Status Meaning Description Schema
200 OK none ChangeRequestUpdateStatus

Response Headers

Status Header Type Format Description
200 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/changeRequests/{changeRequestId}/suggestedReviewers/

List users, suggested to review the Change Request.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/changeRequests/{changeRequestId}/suggestedReviewers/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
changeRequestId path string true ID of the Change Request.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "firstName": "string",
      "lastName": "string",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none SuggestedReviewersResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

ApprovalPolicy

{
  "active": true,
  "automaticAction": {
    "action": "cancel",
    "period": "string"
  },
  "name": "string",
  "review": {
    "groups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "reminderPeriod": "string"
  },
  "trigger": {
    "entityType": "deployment",
    "filterGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "intendedAction": {
      "action": "create",
      "condition": {
        "condition": "equals",
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    },
    "labels": {
      "groupLabel": "string",
      "label": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
active boolean true Whether this policy is active.
automaticAction ApprovalPolicyAutomaticAction false An object describing the automated action on the Change Request that will be performed if the request is not resolved within a given time period after its creation. If null, no automated actions will be taken on the related Change Requests.
name string true maxLength: 50
Name of the Approval Policy.
review ApprovalPolicyReview false An object describing review requirements for Change Requests, related to a specific policy. If null, no additional review requirements are added to the related Change Requests.
trigger ApprovalPolicyTrigger true An object describing the trigger for the Approval Policy.

ApprovalPolicyAutomaticAction

{
  "action": "cancel",
  "period": "string"
}

Properties

Name Type Required Restrictions Description
action string true Action of the workflow automation.
period string(duration) true Period (ISO 8601) after which an action is executed on a Change Request if it is not resolved or cancelled.

Enumerated Values

Property Value
action [cancel, Cancel, CANCEL, approve, Approve, APPROVE]

ApprovalPolicyIntendedAction

{
  "action": "create",
  "condition": {
    "condition": "equals",
    "fieldName": "string",
    "values": [
      "string"
    ]
  }
}

Properties

Name Type Required Restrictions Description
action string true Type of action to trigger on.
condition ApprovalPolicyIntendedActionCondition false An object, describing the condition to trigger on.

Enumerated Values

Property Value
action [create, Create, CREATE, update, Update, UPDATE, delete, Delete, DELETE]

ApprovalPolicyIntendedActionCondition

{
  "condition": "equals",
  "fieldName": "string",
  "values": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
condition string true Condition for the field content to trigger on.
fieldName string true maxLength: 50
Name of the attribute of the entity to filter entities by. An example value is importance attribute for the deployment entity.
values [string]¦null true maxItems: 100
Array of field values to apply condition to trigger on. If null for equals condition, then any value for the field is accepted.

Enumerated Values

Property Value
condition [equals, Equals, EQUALS]

ApprovalPolicyListResponse

{
  "count": 0,
  "data": [
    {
      "active": true,
      "automaticAction": {
        "action": "cancel",
        "period": "string"
      },
      "id": "string",
      "name": "string",
      "openRequests": 0,
      "review": {
        "groups": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "reminderPeriod": "string"
      },
      "trigger": {
        "entityType": "deployment",
        "filterGroups": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "intendedAction": {
          "action": "create",
          "condition": {
            "condition": "equals",
            "fieldName": "string",
            "values": [
              "string"
            ]
          }
        },
        "labels": {
          "groupLabel": "string",
          "label": "string"
        }
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ApprovalPolicyResponse] true List of Approval Policies.
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ApprovalPolicyMatchResponse

{
  "action": "create",
  "entityType": "deployment",
  "fieldName": "string",
  "fieldValue": "string",
  "policyId": "string"
}

Properties

Name Type Required Restrictions Description
action string true Searched policy action.
entityType string true Searched typed of the entity.
fieldName string¦null false maxLength: 50
Name of the entity field to filter policies by.
fieldValue string¦null false maxLength: 50
Value of the entity field to filter policies by.
policyId string¦null true ID of the matching approval policy. null if no matching policies found.

Enumerated Values

Property Value
action [create, Create, CREATE, update, Update, UPDATE, delete, Delete, DELETE]
entityType [deployment, Deployment, DEPLOYMENT, deploymentModel, DeploymentModel, DEPLOYMENT_MODEL, deploymentConfig, DeploymentConfig, DEPLOYMENT_CONFIG, deploymentStatus, DeploymentStatus, DEPLOYMENT_STATUS, deploymentMonitoringData, DeploymentMonitoringData, DEPLOYMENT_MONITORING_DATA]

ApprovalPolicyResponse

{
  "active": true,
  "automaticAction": {
    "action": "cancel",
    "period": "string"
  },
  "id": "string",
  "name": "string",
  "openRequests": 0,
  "review": {
    "groups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "reminderPeriod": "string"
  },
  "trigger": {
    "entityType": "deployment",
    "filterGroups": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "intendedAction": {
      "action": "create",
      "condition": {
        "condition": "equals",
        "fieldName": "string",
        "values": [
          "string"
        ]
      }
    },
    "labels": {
      "groupLabel": "string",
      "label": "string"
    }
  }
}

Properties

Name Type Required Restrictions Description
active boolean true Whether this policy is active.
automaticAction ApprovalPolicyAutomaticAction false An object describing the automated action on the Change Request that will be performed if the request is not resolved within a given time period after its creation. If null, no automated actions will be taken on the related Change Requests.
id string true ID of the Approval Policy.
name string true maxLength: 50
Name of the Approval Policy.
openRequests integer true minimum: 0
Number of open Change Requests associated with the policy.
review ApprovalPolicyReview false An object describing review requirements for Change Requests, related to a specific policy. If null, no additional review requirements are added to the related Change Requests.
trigger ApprovalPolicyTrigger true An object describing the trigger for the Approval Policy.

ApprovalPolicyReview

{
  "groups": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "reminderPeriod": "string"
}

Properties

Name Type Required Restrictions Description
groups [PolicyUserGroup]¦null false maxItems: 100
minItems: 1
A list of user groups that will be added as required reviewers on Change Requests for the entities that match the policy.
reminderPeriod string(duration)¦null false Duration period in ISO 8601 format that indicates when to send a reminder for reviewing a Change Request after its creation or last reminder if it hasn't been approved yet. If null, no review reminders are sent to the reviewers.

ApprovalPolicyTrigger

{
  "entityType": "deployment",
  "filterGroups": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "intendedAction": {
    "action": "create",
    "condition": {
      "condition": "equals",
      "fieldName": "string",
      "values": [
        "string"
      ]
    }
  },
  "labels": {
    "groupLabel": "string",
    "label": "string"
  }
}

Properties

Name Type Required Restrictions Description
entityType string true Type of entity to trigger on.
filterGroups [PolicyUserGroup]¦null false maxItems: 100
A list of user groups to apply Approval Policy for. If User 'A' and User 'B' are both members of the same organisation, and User 'A' is a member of one of the groups listed in this field,but User 'B' is not, then an approval workflow will be triggerred for User 'A' on an action to the entity that matches policy condition, but not for User 'B'. If null, approvals workflow will be triggered for all users.
intendedAction ApprovalPolicyIntendedAction true An object, describing the approvals workflow intended action.
labels ApprovalPolicyTriggerLabel false Trigger Labels.

Enumerated Values

Property Value
entityType [deployment, Deployment, DEPLOYMENT, deploymentModel, DeploymentModel, DEPLOYMENT_MODEL, deploymentConfig, DeploymentConfig, DEPLOYMENT_CONFIG, deploymentStatus, DeploymentStatus, DEPLOYMENT_STATUS, deploymentMonitoringData, DeploymentMonitoringData, DEPLOYMENT_MONITORING_DATA]

ApprovalPolicyTriggerLabel

{
  "groupLabel": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
groupLabel string true Group Label.
label string true Label.

ApprovalWorkflowListTriggerResponse

{
  "data": [
    {
      "entityType": "deployment",
      "filterGroups": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "intendedAction": {
        "action": "create",
        "condition": {
          "condition": "equals",
          "fieldName": "string",
          "values": [
            "string"
          ]
        }
      },
      "labels": {
        "groupLabel": "string",
        "label": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
data [ApprovalPolicyTrigger] true List of available Approval Policy Triggers.

ChangeRequestCreate

{
  "action": "approve",
  "autoApply": false,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "comment": "string",
  "entityId": "string",
  "entityType": "deployment"
}

Properties

oneOf

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentApproveChange true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

xor

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentChangeStatusChange true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

xor

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentChangeImportanceChange true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

xor

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentCleanupStatsChange true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

xor

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentDeleteChange false Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

xor

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentReplaceModelChange true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

xor

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentReplaceModelPackageChange true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

xor

Name Type Required Restrictions Description
anonymous object false none
» action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
» change DeploymentUpdateSecondaryDatasetConfigChange true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.
» comment string false maxLength: 10000
Free form text to comment on the requested changes.
» entityId string true ID of the Product Entity the request is intended to change.
» entityType string true Type of the Product Entity that is requested to be changed.

Enumerated Values

Property Value
action approve
entityType [deployment, Deployment, DEPLOYMENT]
action changeStatus
entityType [deployment, Deployment, DEPLOYMENT]
action changeImportance
entityType [deployment, Deployment, DEPLOYMENT]
action cleanupStats
entityType [deployment, Deployment, DEPLOYMENT]
action delete
entityType [deployment, Deployment, DEPLOYMENT]
action replaceModel
entityType [deployment, Deployment, DEPLOYMENT]
action replaceModelPackage
entityType [deployment, Deployment, DEPLOYMENT]
action updateSecondaryDatasetConfigs
entityType [deployment, Deployment, DEPLOYMENT]

ChangeRequestDiff

{
  "changesFrom": [
    "string"
  ],
  "changesTo": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
changesFrom [string] true maxItems: 1000
List of human readable messages describing the state of the entity before changes are applied.
changesTo [string] true maxItems: 1000
List of human readable messages describing the state of the entity after changes are applied.

ChangeRequestInfoListResponse

{
  "count": 0,
  "data": [
    {
      "changeRequestId": "string",
      "createDate": "2019-08-24T14:15:22Z",
      "entityId": "string",
      "entityName": "string",
      "requester": "string",
      "state": "OPENED",
      "updateDate": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ChangeRequestInfoResponse] true List of Approval Policies.
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ChangeRequestInfoResponse

{
  "changeRequestId": "string",
  "createDate": "2019-08-24T14:15:22Z",
  "entityId": "string",
  "entityName": "string",
  "requester": "string",
  "state": "OPENED",
  "updateDate": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Properties

Name Type Required Restrictions Description
changeRequestId string true ID of the Change Request.
createDate string(date-time) true Change Request creation date.
entityId string true ID of the modified entity.
entityName string¦null true Name of the modified entity.
requester string true Username of the account that initiated a Change Request.
state string true Status of the Change Request.
updateDate string(date-time)¦null true Last date when Change Request was modified.
updatedBy string¦null true Username of the account that last updated the Change Request.

Enumerated Values

Property Value
state [OPENED, RESOLVED, CANCELLED]

ChangeRequestResponse

{
  "action": "approve",
  "autoApply": false,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "changeVersionId": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "diff": {
    "changesFrom": [
      "string"
    ],
    "changesTo": [
      "string"
    ]
  },
  "entityId": "string",
  "entityType": "deployment",
  "id": "string",
  "numApprovalsRequired": 0,
  "processedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "statusChangedAt": "2019-08-24T14:15:22Z",
  "statusChangedBy": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": "string",
  "userName": "string",
  "userOperations": {
    "canCancel": true,
    "canComment": true,
    "canResolve": true,
    "canReview": true,
    "canUpdate": true
  }
}

Properties

Name Type Required Restrictions Description
action string true Actions the user can take on the entity. Each entity type has a specific set of actions.
autoApply boolean true Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
change any true Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.

oneOf

Name Type Required Restrictions Description
» anonymous DeploymentApproveChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentChangeStatusChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentChangeImportanceChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentCleanupStatsChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentReplaceModelChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentReplaceModelPackageChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentUpdateSecondaryDatasetConfigChange false none

continued

Name Type Required Restrictions Description
changeVersionId string true ID of the current version of change within this Change Request. It's possible to modify the changes that have been requested. At the same time, we need to make sure that review is associated with the correct changes, that's why we implement versioning on the changes and associate user reviews with the specific Change Request versions.
comment string false maxLength: 10000
Free form text to comment on the requested changes.
createdAt string(date-time) true Timestamp when the request was created.
diff ChangeRequestDiff true The difference between the current entity state and the state of the entity if the Change Request gets applied.
entityId string true ID of the Product Entity the request is intended to change.
entityType string true Type of the Product Entity that is requested to be changed.
id string true ID of the Change Request.
numApprovalsRequired integer true minimum: 0
Number of approving reviews required for the Change Request to be considered approved.
processedAt string(date-time)¦null true Timestamp when the request was processed.
status string true Change Request Status.
statusChangedAt string(date-time)¦null true Timestamp when the current request status was set. null if status is set by the system.
statusChangedBy string¦null true ID of the user who set the current request status. null if the status was set by the system.
updatedAt string(date-time) true Timestamp when the request was last modified.
userId string true ID of the user, who created the Change Request.
userName string¦null true Email of the user, who created the Change Request
userOperations UserOperations true A set operations the user can or can not make with the Change Request.

Enumerated Values

Property Value
action [approve, Approve, APPROVE, changeStatus, ChangeStatus, CHANGE_STATUS, changeImportance, ChangeImportance, CHANGE_IMPORTANCE, cleanupStats, CleanupStats, CLEANUP_STATS, delete, Delete, DELETE, replaceModel, ReplaceModel, REPLACE_MODEL, replaceModelPackage, ReplaceModelPackage, REPLACE_MODEL_PACKAGE, updateSecondaryDatasetConfigs, UpdateSecondaryDatasetConfigs, UPDATE_SECONDARY_DATASET_CONFIGS]
entityType [deployment, Deployment, DEPLOYMENT]
status [pending, Pending, PENDING, approved, Approved, APPROVED, changesRequested, ChangesRequested, CHANGES_REQUESTED, resolved, Resolved, RESOLVED, cancelled, Cancelled, CANCELLED]

ChangeRequestUpdate

{
  "autoApply": true,
  "change": {
    "approvalStatus": "APPROVED"
  },
  "comment": "string"
}

Properties

Name Type Required Restrictions Description
autoApply boolean false Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
change any false Change that the user wants to apply to the entity. Needs to be provided if the action, like approve action for a deployment, requires additional parameters . null if the action does not require any additional parameters to be applied.

oneOf

Name Type Required Restrictions Description
» anonymous DeploymentApproveChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentChangeStatusChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentChangeImportanceChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentCleanupStatsChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentReplaceModelChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentReplaceModelPackageChange false none

xor

Name Type Required Restrictions Description
» anonymous DeploymentUpdateSecondaryDatasetConfigChange false none

continued

Name Type Required Restrictions Description
comment string false maxLength: 10000
Free form text to comment on the requested changes.

ChangeRequestUpdateStatus

{
  "status": "cancelled"
}

Properties

Name Type Required Restrictions Description
status string true Change Request status to set.

Enumerated Values

Property Value
status [cancelled, resolving]

ChangeRequestsListResponse

{
  "count": 0,
  "data": [
    {
      "action": "approve",
      "autoApply": false,
      "change": {
        "approvalStatus": "APPROVED"
      },
      "changeVersionId": "string",
      "comment": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "diff": {
        "changesFrom": [
          "string"
        ],
        "changesTo": [
          "string"
        ]
      },
      "entityId": "string",
      "entityType": "deployment",
      "id": "string",
      "numApprovalsRequired": 0,
      "processedAt": "2019-08-24T14:15:22Z",
      "status": "pending",
      "statusChangedAt": "2019-08-24T14:15:22Z",
      "statusChangedBy": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userId": "string",
      "userName": "string",
      "userOperations": {
        "canCancel": true,
        "canComment": true,
        "canResolve": true,
        "canReview": true,
        "canUpdate": true
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ChangeRequestResponse] true maxItems: 1000
List of Change Requests
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

DeploymentApproveChange

{
  "approvalStatus": "APPROVED"
}

Properties

Name Type Required Restrictions Description
approvalStatus string true Deployment approval status to set.

Enumerated Values

Property Value
approvalStatus APPROVED

DeploymentChangeImportanceChange

{
  "importance": "CRITICAL"
}

Properties

Name Type Required Restrictions Description
importance string true Deployment Importance to set.

Enumerated Values

Property Value
importance [CRITICAL, HIGH, MODERATE, LOW]

DeploymentChangeStatusChange

{
  "status": "active"
}

Properties

Name Type Required Restrictions Description
status string true Deployment status to set.

Enumerated Values

Property Value
status [active, inactive]

DeploymentCleanupStatsChange

{
  "dataType": "monitoring",
  "end": "2019-08-24T14:15:22Z",
  "modelId": null,
  "start": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
dataType string true Type of stats to cleanup.
end string(date-time)¦null true If specified, the stats will be cleaned up to this timestamp. If null all stats till the deployment end forecast date will be cleaned up. Defaults to null.
modelId string¦null true ID of the model to remove deployment stats for. If null, the stats will be cleaned up for all models in the mathcing period. Defaults to null.
start string(date-time)¦null true If specified, the stats will be cleaned up from this timestamp. If null all stats from the deployment start forecast date will be cleaned up. Defaults to null.

Enumerated Values

Property Value
dataType monitoring

DeploymentDeleteChange

{
  "defaultDeploymentId": "string",
  "ignoreManagementAgent": "false"
}

Properties

Name Type Required Restrictions Description
defaultDeploymentId string false Used by management agent to recalculate endpoint traffic. Traffic from the deploymentbeing deleted flipped to a default deployment.
ignoreManagementAgent string false Do not wait for management agent to delete the deployment first.

Enumerated Values

Property Value
ignoreManagementAgent [false, False, true, True]

DeploymentReplaceModelChange

{
  "modelId": "string",
  "replacementReason": "accuracy"
}

Properties

Name Type Required Restrictions Description
modelId string true ID of the Model to deploy.
replacementReason string true Reason for replacement.

Enumerated Values

Property Value
replacementReason [accuracy, data_drift, errors, scheduled_refresh, scoring_speed, deprecation, other]

DeploymentReplaceModelPackageChange

{
  "modelPackageId": "string",
  "replacementReason": "accuracy"
}

Properties

Name Type Required Restrictions Description
modelPackageId string true ID of the Model Package to deploy.
replacementReason string true Reason for replacement.

Enumerated Values

Property Value
replacementReason [accuracy, data_drift, errors, scheduled_refresh, scoring_speed, deprecation, other]

DeploymentUpdateSecondaryDatasetConfigChange

{
  "secondaryDatasetsConfigId": "string"
}

Properties

Name Type Required Restrictions Description
secondaryDatasetsConfigId string true ID of the secondary dataset configs.

PolicyUserGroup

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id string true ID of the user group.
name string¦null false maxLength: 50
Name of the user group.

ReviewCreate

{
  "changeVersionId": "string",
  "comment": "string",
  "status": "approved"
}

Properties

Name Type Required Restrictions Description
changeVersionId string true ID of the change version.
comment string false maxLength: 10000
Free form text to comment on the review.
status string true Status of the review.

Enumerated Values

Property Value
status [approved, Approved, APPROVED, changesRequested, ChangesRequested, CHANGES_REQUESTED, commented, Commented, COMMENTED]

ReviewResponse

{
  "changeRequestId": "string",
  "changeVersionId": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "status": "approved",
  "userId": "string",
  "userName": "string"
}

Properties

Name Type Required Restrictions Description
changeRequestId string true ID of the Change Request.
changeVersionId string true ID of the change version.
comment string false maxLength: 10000
Free form text to comment on the review.
createdAt string(date-time) true Timestamp when the review was created.
id string true ID of the review.
status string true Status of the review.
userId string true ID of the user, who created the review.
userName string¦null true Email of the user, who created the review

Enumerated Values

Property Value
status [approved, Approved, APPROVED, changesRequested, ChangesRequested, CHANGES_REQUESTED, commented, Commented, COMMENTED]

ReviewsListResponse

{
  "count": 0,
  "data": [
    {
      "changeRequestId": "string",
      "changeVersionId": "string",
      "comment": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "status": "approved",
      "userId": "string",
      "userName": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ReviewResponse] true maxItems: 1000
List of change request reviews.
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

SuggestedReviewersResponse

{
  "count": 0,
  "data": [
    {
      "firstName": "string",
      "lastName": "string",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [UserInfo] true maxItems: 1000
List of suggested change request reviewers.
next string(uri)¦null true URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

UserInfo

{
  "firstName": "string",
  "lastName": "string",
  "userId": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
firstName string true First Name.
lastName string true Last Name.
userId string true ID of the User.
username string true Username.

UserOperations

{
  "canCancel": true,
  "canComment": true,
  "canResolve": true,
  "canReview": true,
  "canUpdate": true
}

Properties

Name Type Required Restrictions Description
canCancel boolean true Whether the user can cancel the Change Request.
canComment boolean true Whether the user can create commenting review on the Change Request.
canResolve boolean true Whether the user can resolve the Change Request.
canReview boolean true Whether the user can review (approve or request updates) the Change Request.
canUpdate boolean true Whether the user can update the Change Request.

Updated March 18, 2024