Request
Request
JSON Example
{
"requestedFor": "string",
"deploymentRequestName": "string",
"components": [
{
"componentId": "string",
"requestType": "string",
"description": "string",
"parentId": "string",
"cafeResourceId": "string",
"classId": "string",
"quote": {
"leasePeriod": {
"unit": "string",
"amount": 0
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": 0
}
}
},
"typeFilter": "string",
"providerId": "string",
"name": "string",
"serviceTypeId": "string",
"requestableItemBindingId": "string",
"id": "string"
}
],
"reasons": "string",
"postApprovalId": "string",
"requestorEntitlementId": {
"lastUpdatedBy": "string",
"entitledServices": [
{
"active": false,
"approvalPolicyId": "string",
"serviceRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"owner": {
"ref": "string",
"lastSync": "string",
"expired": false,
"tenantName": "string",
"name": "string",
"id": "string",
"type": "string"
},
"lastUpdatedBy": "string",
"hours": {
"startTime": "string",
"endTime": "string"
},
"description": "string",
"supportTeam": {
"ref": "string",
"lastSync": "string",
"expired": false,
"tenantName": "string",
"name": "string",
"id": "string",
"type": "string"
},
"version": 0,
"lastUpdatedDate": "string",
"changeWindow": {
"hours": {
"startTime": "string",
"endTime": "string"
},
"dayOfWeek": "string"
},
"name": "string",
"statusName": "string",
"newDuration": {
"unit": "string",
"amount": 0
},
"id": "string",
"status": "string"
}
}
],
"allUsers": false,
"entitledCatalogItems": [
{
"hidden": false,
"catalogItemRequestable": false,
"active": false,
"catalogItemRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"isNoteworthy": false,
"providerBinding": {
"providerRef": {
"name": "string",
"providerTypeId": {
"name": "string",
"id": "string"
},
"id": "string"
},
"bindingId": "string"
},
"callbacks": {
"rollback": false,
"itemInitialize": false,
"itemInformation": false,
"validate": false
},
"description": "string",
"serviceRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"owner": {
"ref": "string",
"lastSync": "string",
"expired": false,
"tenantName": "string",
"name": "string",
"id": "string",
"type": "string"
},
"lastUpdatedBy": "string",
"hours": {
"startTime": "string",
"endTime": "string"
},
"description": "string",
"supportTeam": {
"ref": "string",
"lastSync": "string",
"expired": false,
"tenantName": "string",
"name": "string",
"id": "string",
"type": "string"
},
"version": 0,
"lastUpdatedDate": "string",
"changeWindow": {
"hours": {
"startTime": "string",
"endTime": "string"
},
"dayOfWeek": "string"
},
"name": "string",
"statusName": "string",
"newDuration": {
"unit": "string",
"amount": 0
},
"id": "string",
"status": "string"
},
"version": 0,
"lastUpdatedDate": "string",
"dateCreated": "string",
"catalogItemTypeRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"requestSchema": {
"classId": "string",
"typeFilter": "string"
},
"description": "string",
"callbacks": {
"rollback": false,
"itemInitialize": false,
"itemInformation": false,
"validate": false
},
"outputResourceTypeId": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"schema": {
"classId": "string",
"typeFilter": "string"
},
"pluralizedName": "string",
"parentTypeId": "ResourceType Object",
"callbacks": {
"details": false,
"list": false
},
"costFeatures": {
"leaseCost": false,
"lease": false
},
"description": "string",
"deleteIfNoChildren": false,
"listView": {
"columns": [
{
"filterable": false,
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"orderIndex": 0,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sortable": false
}
],
"defaultSequence": [
"string"
]
},
"name": "string",
"providerTypeId": {
"name": "string",
"id": "string"
},
"id": "string",
"forms": {
"catalogResourceInfoHidden": false
},
"listDescendantTypesSeparately": false,
"primary": false,
"showChildrenOutsideParent": false,
"status": "string"
},
"createCustomApprovalTypes": false,
"itemSchema": {
"classId": "string",
"typeFilter": "string"
},
"providerId": {
"name": "string",
"providerTypeId": {
"name": "string",
"id": "string"
},
"id": "string"
},
"name": "string",
"providerTypeId": {
"name": "string",
"id": "string"
},
"id": "string",
"requestable": false,
"forms": {
"requestFormScale": "string",
"catalogRequestInfoHidden": false
}
},
"outputResourceTypeRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"schema": {
"classId": "string",
"typeFilter": "string"
},
"pluralizedName": "string",
"parentTypeId": "ResourceType Object",
"callbacks": {
"details": false,
"list": false
},
"costFeatures": {
"leaseCost": false,
"lease": false
},
"description": "string",
"deleteIfNoChildren": false,
"listView": {
"columns": [
{
"filterable": false,
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"orderIndex": 0,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sortable": false
}
],
"defaultSequence": [
"string"
]
},
"name": "string",
"providerTypeId": {
"name": "string",
"id": "string"
},
"id": "string",
"forms": {
"catalogResourceInfoHidden": false
},
"listDescendantTypesSeparately": false,
"primary": false,
"showChildrenOutsideParent": false,
"status": "string"
},
"quota": 0,
"name": "string",
"statusName": "string",
"id": "string",
"requestable": false,
"forms": {
"requestFormScale": "string",
"catalogRequestInfoHidden": false
},
"status": "string"
},
"approvalPolicyId": "string"
}
],
"description": "string",
"principals": [
{
"ref": "string",
"lastSync": "string",
"expired": false,
"tenantName": "string",
"name": "string",
"id": "string",
"type": "string"
}
],
"allResourceActions": false,
"version": 0,
"priorityOrder": 0,
"allCatalogItems": false,
"expiryDate": "string",
"lastUpdatedDate": "string",
"name": "string",
"statusName": "string",
"id": "string",
"entitledResourceOperations": [
{
"targetResourceTypeRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"schema": {
"classId": "string",
"typeFilter": "string"
},
"pluralizedName": "string",
"parentTypeId": "ResourceType Object",
"callbacks": {
"details": false,
"list": false
},
"costFeatures": {
"leaseCost": false,
"lease": false
},
"description": "string",
"deleteIfNoChildren": false,
"listView": {
"columns": [
{
"filterable": false,
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"orderIndex": 0,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sortable": false
}
],
"defaultSequence": [
"string"
]
},
"name": "string",
"providerTypeId": {
"name": "string",
"id": "string"
},
"id": "string",
"forms": {
"catalogResourceInfoHidden": false
},
"listDescendantTypesSeparately": false,
"primary": false,
"showChildrenOutsideParent": false,
"status": "string"
},
"externalId": "string",
"active": false,
"approvalPolicyId": "string",
"resourceOperationType": "string",
"resourceOperationRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"name": "string",
"targetResourceTypeRef": {
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"schema": {
"classId": "string",
"typeFilter": "string"
},
"pluralizedName": "string",
"parentTypeId": "ResourceType Object",
"callbacks": {
"details": false,
"list": false
},
"costFeatures": {
"leaseCost": false,
"lease": false
},
"description": "string",
"deleteIfNoChildren": false,
"listView": {
"columns": [
{
"filterable": false,
"permissibleValues": {
"customAllowed": false
},
"displayAdvice": "string",
"dataType": {
"typeId": "string"
},
"isMultiValued": false,
"description": "string",
"orderIndex": 0,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sortable": false
}
],
"defaultSequence": [
"string"
]
},
"name": "string",
"providerTypeId": {
"name": "string",
"id": "string"
},
"id": "string",
"forms": {
"catalogResourceInfoHidden": false
},
"listDescendantTypesSeparately": false,
"primary": false,
"showChildrenOutsideParent": false,
"status": "string"
},
"entitleable": false,
"externalId": "string",
"description": "string",
"id": "string",
"status": "string"
}
}
],
"localScopeForActions": false,
"status": "string"
},
"requestedItemName": "string",
"description": "string",
"lastUpdated": "string",
"requestNumber": 0,
"dateCreated": "string",
"quote": {
"leasePeriod": {
"unit": "string",
"amount": 0
},
"leaseRate": {
"basis": {
"unit": "string",
"amount": 0
}
}
},
"requestCompletion": {
"requestCompletionState": "string",
"resourceBindingIds": [
"string"
],
"completionDetails": "string"
},
"stateName": "string",
"dateApproved": "string",
"dateCompleted": "string",
"id": "string",
"state": "string",
"requestData": {
"entries": [
{
"key": "string"
}
]
},
"preApprovalId": "string",
"successful": false,
"iconId": {
"image": [
"string"
],
"fileName": "string",
"id": "string",
"contentType": "string"
},
"approvalStatus": "string",
"phase": "string",
"executionStatus": "string",
"waitingStatus": "string",
"version": 0,
"retriesRemaining": 0,
"requestedItemDescription": "string",
"requestedBy": "string",
"final": false,
"dateSubmitted": "string"
}
string
requestedFor
Optional
requestedFor
string
deploymentRequestName
Optional
deploymentRequestName
string
reasons
Optional
reasons
string
postApprovalId
Optional
postApprovalId
string
requestedItemName
Optional
requestedItemName
string
description
Optional
description
string As date-time
As date-time
lastUpdated
Optional
lastUpdated
integer As int64
As int64
requestNumber
Optional
requestNumber
string As date-time
As date-time
dateCreated
Optional
dateCreated
string
stateName
Optional
stateName
string As date-time
As date-time
dateApproved
Optional
dateApproved
string As date-time
As date-time
dateCompleted
Optional
dateCompleted
string As uuid
As uuid
id
Optional
id
string
state
Required
state
Possible values are :
UNSUBMITTED,
SUBMITTED,
DELETED,
PENDING_PRE_APPROVAL,
CANCELLING,
CANCELLED,
PRE_APPROVAL_SEND_ERROR,
PRE_APPROVED,
PRE_REJECTED,
PROVIDER_DELETION_ERROR,
IN_PROGRESS,
PROVIDER_SEND_ERROR,
PROVIDER_COMPLETED,
PROVIDER_FAILED,
PENDING_POST_APPROVAL,
POST_APPROVAL_SEND_ERROR,
POST_APPROVED,
POST_REJECTION_RECEIVED,
ROLLBACK_ERROR,
POST_REJECTED,
SUCCESSFUL,
PARTIALLY_SUCCESSFUL,
FAILED,
string
preApprovalId
Optional
preApprovalId
boolean
successful
Optional
successful
string
approvalStatus
Optional
approvalStatus
Possible values are :
PENDING,
PRE_APPROVED,
POST_APPROVED,
REJECTED,
string
phase
Optional
phase
Possible values are :
UNSUBMITTED,
PENDING_PRE_APPROVAL,
IN_PROGRESS,
PENDING_POST_APPROVAL,
SUCCESSFUL,
FAILED,
REJECTED,
string
executionStatus
Optional
executionStatus
Possible values are :
NOT_STARTED,
STARTED,
STOPPED,
string
waitingStatus
Optional
waitingStatus
Possible values are :
NOT_WAITING,
WAITING_FOR_APPROVAL,
WAITING_FOR_PROVIDER,
integer As int64
As int64
version
Optional
version
integer As int64
As int64
retriesRemaining
Optional
retriesRemaining
string
requestedItemDescription
Optional
requestedItemDescription
string
requestedBy
Optional
requestedBy
boolean
final
Optional
final
string As date-time
As date-time
dateSubmitted
Optional
dateSubmitted