Get a request
get
/epm/rest/v1/requests/{requestId}
Request
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Request
Type:
object
A Request models changes to apply to a View
Show Source
-
actionCount:
integer(int32)
Read Only:
true
-
ageInDays:
integer(int64)
Read Only:
true
-
approvalUsers:
array approvalUsers
Read Only:
true
-
assignedTo:
string
Read Only:
true
This property is now deprecated. Use assignedToUser instead. -
assignedToUser:
object User
-
attachmentCount:
integer(int32)
Read Only:
true
-
autoSubmitted:
boolean
-
blockedUntil:
integer(int64)
Read Only:
true
-
commentCount:
integer(int32)
Read Only:
true
-
commitUsers:
array commitUsers
Read Only:
true
-
consolidationRequest:
object IdNameDescription
-
consolidationRequestNumber:
integer(int32)
Read Only:
true
-
consolidationRequestStatus:
string
Read Only:
true
Allowed Values:[ "DRAFT", "IN_FLIGHT", "PUSHED_BACK", "COMPLETED", "REJECTED", "RECALLED", "BLOCKED" ]
Specifies the allowable statuses for a consolidation request. -
createdBy:
string
Read Only:
true
This property is now deprecated. Use createdByUser instead. -
createdByUser:
object User
-
description:
string
Read Only:
true
-
hasViewAccess:
boolean
Read Only:
true
-
id:
string(uuid)
Read Only:
true
-
initialSubmit:
integer(int64)
Read Only:
true
-
inviteeUsers:
array inviteeUsers
Read Only:
true
-
itemCount:
integer(int32)
Read Only:
true
-
links:
array links
Read Only:
true
-
modifiedBy:
string
Read Only:
true
This property is now deprecated. Use modifiedByUser instead. -
modifiedByUser:
object User
-
notes:
string
Read Only:
true
-
origin:
string
Read Only:
true
Allowed Values:[ "INTERACTIVE", "SUBSCRIPTION", "IMPORT", "CONSOLIDATION", "LOAD" ]
Specifies the allowable origins for a request. -
owner:
object User
-
priority:
string
Read Only:
true
Allowed Values:[ "NONE", "LOW", "MEDIUM", "HIGH" ]
-
requestNumber:
integer(int32)
Read Only:
true
-
requestType:
string
Read Only:
true
Allowed Values:[ "INTERACTIVE", "SUBSCRIPTION", "IMPORT", "CONSOLIDATION", "LOAD" ]
Specifies the allowable request types for a request. -
sourceRequest:
object IdNameLink
-
stage:
string
Read Only:
true
Allowed Values:[ "SUBMIT", "APPROVE", "COMMIT", "CLOSED" ]
Specifies the allowable stages for a request. -
status:
string
Read Only:
true
Allowed Values:[ "DRAFT", "IN_FLIGHT", "PUSHED_BACK", "COMPLETED", "REJECTED", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
Specifies the allowable statuses for a request. -
submittedBy:
string
Read Only:
true
This property is now deprecated. Use submittedByUser instead. -
submittedByUser:
object User
-
subscriptions:
array subscriptions
Read Only:
true
-
timeCreated:
integer(int64)
Read Only:
true
-
timeLabel:
object TimeLabel
-
timeLabelChangeAllowed:
boolean
-
timeLabelTimestamp:
integer(int64)
Read Only:
true
-
timeModified:
integer(int64)
Read Only:
true
-
timeSubmitted:
integer(int64)
Read Only:
true
-
title:
string
Read Only:
true
-
validationErrorCount:
integer(int32)
Read Only:
true
-
validTransitionActions:
array validTransitionActions
Read Only:
true
-
valWarningCountOnClose:
integer(int32)
Read Only:
true
If the request is closed, the number of validation warnings that existed, and were allowed, at the time it was closed. -
viewId:
string(uuid)
Read Only:
true
-
viewName:
string
Read Only:
true
-
viewStatus:
string
Read Only:
true
Allowed Values:[ "DRAFT", "ACTIVE", "ARCHIVED", "DELETED" ]
Specifies the allowable statuses for a view.
Nested Schema : User
Type:
Show Source
object
-
artifactAssignments:
array artifactAssignments
-
associatedRoles:
array associatedRoles
-
dataManagerOnAny:
boolean
-
emailAddresses:
array emailAddresses
-
epmIdleSessionTimeout:
integer(int32)
-
firstName:
string
-
fullName:
string
-
grantPermission:
string
Allowed Values:
[ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
-
homePageLayoutName:
string
-
id:
string(uuid)
-
lastName:
string
-
links:
array links
-
nameInitials:
string
-
preferences:
object Preferences
-
ssoToken:
string
-
userName:
string
-
userServiceAdministrator:
boolean
Nested Schema : IdNameLink
Type:
Show Source
object
-
description:
string
Read Only:
true
-
id:
string(uuid)
-
links:
array links
-
name:
string
Nested Schema : TimeLabel
Type:
Show Source
object
-
asOfTime:
integer(int64)
Read Only:
true
-
created:
integer(int64)
Read Only:
true
-
createdBy:
string(uuid)
Read Only:
true
-
description:
string
Read Only:
true
-
ftlAssignedToActiveRequest:
boolean
Read Only:
true
-
id:
string(uuid)
Read Only:
true
-
lastModified:
integer(int64)
Read Only:
true
-
links:
array links
Read Only:
true
-
modifiedBy:
string(uuid)
Read Only:
true
-
name:
string
Read Only:
true
-
ownerId:
string(uuid)
Read Only:
true
-
private:
boolean
-
rollingTimeLabelData:
object RollingTimeLabelData
-
timeLabelClass:
string
Read Only:
true
Allowed Values:[ "HISTORICAL", "FUTURE" ]
-
timeLabelType:
string
Read Only:
true
Allowed Values:[ "SPECIFIED", "ROLLING_PERIOD", "REQUEST" ]
-
timeZone:
object ZoneId
-
viewId:
string(uuid)
Read Only:
true
Nested Schema : validTransitionActions
Type:
array
Read Only:
Show Source
true
-
Array of:
string
Allowed Values:
[ "SUBMIT", "APPROVE", "PUSHBACK", "REJECT", "WITHDRAW", "RECALL", "COMMIT", "CLOSE" ]
Nested Schema : Preferences
Type:
Show Source
object
-
actAsThisRole:
string
Allowed Values:
[ "USER", "SERVICE_ADMINISTRATOR" ]
-
delegateToUserId:
string(uuid)
-
languageTag:
string
-
links:
array links
-
outOfOffice:
boolean
-
profilePictureId:
string(uuid)
-
timeZone:
object TimeZone
Nested Schema : Artifact
Type:
Show Source
object
-
id:
string(uuid)
-
name:
string
-
type:
string
Allowed Values:
[ "CLUSTER", "CARD" ]
Nested Schema : RollingTimeLabelData
Type:
Show Source
object
-
offset:
integer(int32)
-
timeOfDay:
string
-
unit:
string
Allowed Values:
[ "NONE", "END_OF_MONTH", "END_OF_YEAR", "END_OF_QUARTER", "FISCAL_QUARTER_END", "FISCAL_YEAR_END" ]
Nested Schema : ZoneOffsetTransitionRule
Type:
Show Source
object
-
dayOfMonthIndicator:
integer(int32)
-
dayOfWeek:
string
Allowed Values:
[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
-
localTime:
object LocalTime
-
midnightEndOfDay:
boolean
-
month:
string
Allowed Values:
[ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
-
offsetAfter:
object ZoneOffset
-
offsetBefore:
object ZoneOffset
-
standardOffset:
object ZoneOffset
-
timeDefinition:
string
Allowed Values:
[ "UTC", "WALL", "STANDARD" ]
403 Response
Forbidden
404 Response
Not Found
Examples
The following example shows how to retrieve a request by submitting a get request on the REST resource using cURL.
cURL Command
curl --user epm_cloud_user -X GET \ https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4
Example of Response Body
The following shows an example of the response body in JSON format.
{ "id": "e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4", "title": "Automated Request", "description": "A requested created with the autmotion API", "status": "DRAFT", "stage": "SUBMIT", "priority": "NONE", "requestNumber": 1043, "timeCreated": "2018-04-02T18:24:05.890Z", "timeModified": "2018-04-02T20:20:22.540Z", "timeSubmitted": "2018-04-02T18:24:05.890Z", "createdBy": "demoadmin", "modifiedBy": "demoadmin", "submittedBy": "demoadmin", "itemCount": 5, "commentCount": 0, "validationErrorCount": 32, "attachmentCount": 1, "actionCount": 22, "viewId": "91fab006-5185-478f-9d3c-c1b4548a0b10", "viewName": "Corporate Planning (EPBCS)", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4" }, { "rel": "edit", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4", "method": "PUT" }, { "rel": "delete", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4", "method": "DELETE" }, { "rel": "patch", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4", "method": "PATCH" }, { "rel": "comments", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/comments" }, { "rel": "patchItems", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/items", "method": "PATCH" }, { "rel": "view", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10" }, { "rel": "items", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/items" }, { "rel": "uploadAnyFile", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/attachments", "method": "POST" }, { "rel": "uploadImportFile", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/attachments/importFile", "method": "POST" }, { "rel": "importAttached", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/import", "method": "POST" }, { "rel": "parseResults", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/parseResults", "method": "POST" }, { "rel": "attachments", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/attachments" }, { "rel": "transitionRequest", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/transitions", "method": "POST" }, { "rel": "validate", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/validations", "method": "POST" }, { "rel": "export", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/export", "method": "POST" }, { "rel": "addNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/addNode", "templated": true, "method": "POST" }, { "rel": "insertNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/insertNode", "templated": true, "method": "POST" }, { "rel": "deleteNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/deleteNode", "templated": true, "method": "POST" }, { "rel": "updateNodeProp", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/updateNodeProp", "templated": true, "method": "POST" }, { "rel": "renameNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/renameNode", "templated": true, "method": "POST" }, { "rel": "moveNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/moveNode", "templated": true, "method": "POST" }, { "rel": "removeNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/removeNode", "templated": true, "method": "POST" }, { "rel": "reorderNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/reorderNode", "templated": true, "method": "POST" }, { "rel": "deleteActions", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/deleteActions", "templated": true, "method": "POST" }, { "rel": "deleteAction", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/edits/{nodeId}/deleteAction/{requestActionId}", "templated": true, "method": "POST" } ], "validTransitionActions": [], "permittedActions": [ "DELETE", "EDIT" ] }