# You can also use wget
curl -X GET http://10.97.68.125/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.
# You can also use wget
curl -X POST http://10.97.68.125/api/v2/approvalPolicies/ \
-H 'Content-Type: application/json'\
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/api/v2/approvalPolicies/{approvalPolicyId}/ \
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X PUT http://10.97.68.125/api/v2/approvalPolicies/{approvalPolicyId}/ \
-H 'Content-Type: application/json'\
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/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.
# You can also use wget
curl -X GET http://10.97.68.125/api/v2/approvalPolicyMatch/?entityType=deployment&action=create \
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/api/v2/approvalPolicyTriggers/ \
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/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.
# You can also use wget
curl -X POST http://10.97.68.125/api/v2/changeRequests/ \
-H 'Content-Type: application/json'\
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/api/v2/changeRequests/{changeRequestId}/ \
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/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.
# You can also use wget
curl -X POST http://10.97.68.125/api/v2/changeRequests/{changeRequestId}/reviews/ \
-H 'Content-Type: application/json'\
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/api/v2/changeRequests/{changeRequestId}/reviews/{reviewId}/ \
-H 'Accept: application/json'\
-H 'Authorization: Bearer {access-token}'
# You can also use wget
curl -X GET http://10.97.68.125/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.
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.
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.
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
none
ID of the Approval Policy.
name
string
true
none
Name of the Approval Policy.
openRequests
integer
true
none
Number of open Change Requests associated with the policy.
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.
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
none
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.
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.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
xor
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» action
string
true
none
Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
xor
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» action
string
true
none
Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
xor
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» action
string
true
none
Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
xor
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» action
string
true
none
Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
xor
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» action
string
true
none
Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
xor
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» action
string
true
none
Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
xor
Name
Type
Required
Restrictions
Description
anonymous
object
false
none
none
» action
string
true
none
Actions the user can take on the entity. Each entity type has a specific set of actions.
» autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
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
none
Free form text to comment on the requested changes.
» entityId
string
true
none
ID of the Product Entity the request is intended to change.
» entityType
string
true
none
Type of the Product Entity that is requested to be changed.
Actions the user can take on the entity. Each entity type has a specific set of actions.
autoApply
boolean
true
none
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
change
any
true
none
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.
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
none
Free form text to comment on the requested changes.
Whether to automatically apply the change when the request is approved. If true, the requested changes will be applied on approval.
change
any
false
none
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.
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
none
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
none
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.
