Query requests
get
/epm/rest/v1/requests/byName/query
Request
Query Parameters
-
expand: array[string]
Collection Format:
multi
Expands the response with additional information-
Allowed Values:
[ "workflow" ]
-
-
fromDate: integer(int64)
From Date in Epoch time, Difference between from and to date can be max of 90 daysAllowed Values:
[ "Epoch time eg: 1659339021" ]
-
lastDays: integer(int32)
Number of days in the past from the current date. Maximum value is 90.Allowed Values:
[ "Non zero positive integer" ]
-
myActivity: array[string]
Collection Format:
multi
Activity names separated by comma-
Allowed Values:
[ "Assigned", "Collaborated", "Submitted", "Invited", "Contributed", "Managed" ]
-
-
owner: array[string]
Collection Format:
multi
Owner names separated by comma-
Allowed Values:
[ "Name of the owner" ]
-
-
priority: array[string]
Collection Format:
multi
Priorities separated by comma-
Allowed Values:
[ "None", "Low", "Medium", "High" ]
-
-
requestNumber: array[string]
Collection Format:
multi
Request Number-
Allowed Values:
[ "Nonzero positive integer" ]
-
-
requestType: array[string]
Collection Format:
multi
Request types separated by comma-
Allowed Values:
[ "Interactive", "Subscription", "Import", "Consolidation" ]
-
-
stage: array[string]
Collection Format:
multi
Stage of the request separated by comma-
Allowed Values:
[ "Submit", "Approved", "Commit", "Closed" ]
-
-
status: array[string]
Collection Format:
multi
Status separated by comma-
Allowed Values:
[ "Draft", "In Flight", "Recalled", "Pushed Back", "Completed", "Rejected", "Blocked", "Consolidated" ]
-
-
toDate: integer(int64)
To Date in Epoch time, Difference between from and to date can be max of 90 daysAllowed Values:
[ "Epoch time eg: 1659339021" ]
-
viewName: array[string]
Collection Format:
multi
View names separated by comma-
Allowed Values:
[ "Name of the view in application" ]
-
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : ItemsRequest
Type:
Show Source
object
-
count:
integer(int32)
-
hasMore:
boolean
-
items:
array items
Read Only:
true
-
limit:
integer(int32)
-
links:
array links
Read Only:
true
-
offset:
integer(int32)
-
totalResults:
integer(int32)
Nested Schema : items
Type:
array
Read Only:
Show Source
true
-
Array of:
object Request
A Request models changes to apply to a View
Nested 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 and will be removed in 10/2020. 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", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
-
createdBy:
string
Read Only:
true
This property is now deprecated and will be removed in 10/2020. 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 and will be removed in 10/2020. Use modifiedByUser instead. -
modifiedByUser:
object User
-
notes:
string
Read Only:
true
-
origin:
string
Read Only:
true
Allowed Values:[ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
-
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:[ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
-
sourceRequest:
object IdNameLink
-
stage:
string
Read Only:
true
Allowed Values:[ "SUBMIT", "REVIEW", "ENRICH", "APPROVE", "COMMIT", "CLOSED" ]
-
status:
string
Read Only:
true
Allowed Values:[ "DRAFT", "IN_FLIGHT", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
-
submittedBy:
string
Read Only:
true
This property is now deprecated and will be removed in 10/2020. Use submittedByUser instead. -
submittedByUser:
object User
-
subscriptions:
array subscriptions
Read Only:
true
-
timeCreated:
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", "SUNSET", "ARCHIVED", "DELETED" ]
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
Nested Schema : IdNameLink
Type:
Show Source
object
-
description:
string
Read Only:
true
-
id:
string(uuid)
-
links:
array links
-
name:
string
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 : Artifact
Type:
Show Source
object
-
id:
string(uuid)
-
name:
string
-
type:
string
Allowed Values:
[ "CLUSTER", "CARD" ]
400 Response
Error Response
404 Response
Not Found
Examples
The following example shows how to retrieve request summary 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/byName/query?lastDays=6&expand=workflow
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "id": "d00decfe-c188-422c-a498-3bf901498b53", "title": "Automated Request", "description": "Description for Automated Request", "requestType": "INTERACTIVE", "status": "DRAFT", "stage": "SUBMIT", "priority": "NONE", "requestNumber": 1234, "timeCreated": "2022-09-09T08:22:30.987Z", "timeModified": "2022-09-09T08:22:40.563Z", "inviteeUsers": [ { "id": "f805fa38-d8e2-4e67-9aa8-87e442082526", "userName": "demo1user", "fullName": "demo1 user", "firstName": "demo1", "lastName": "user", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/f805fa38-d8e2-4e67-9aa8-87e442082526" } ], "nameInitials": "du", "dataManagerOnAny": false } ], "approvalUsers": [ { "id": "a9ea2b84-32ec-4fb5-ab8a-ca86a933959a", "userName": "demo2user", "fullName": "demo2 user", "firstName": "demo2", "lastName": "user", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/a9ea2b84-32ec-4fb5-ab8a-ca86a933959a" } ], "nameInitials": "du", "dataManagerOnAny": false } ], "commitUsers": [ { "id": "a9ea2b84-32ec-4fb5-ab8a-ca86a933959x", "userName": "demo3user", "fullName": "demo3 user", "firstName": "demo3", "lastName": "user", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/a9ea2b84-32ec-4fb5-ab8a-ca86a933959x" } ], "nameInitials": "du", "dataManagerOnAny": false } ], "itemCount": 0, "commentCount": 0, "validationErrorCount": 0, "attachmentCount": 0, "viewId": "43d5ce15-0711-4603-8cc4-1b90c14d3136", "viewName": "Departments", "hasViewAccess": true, "links": [ { "rel": "delete", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53", "method": "DELETE" }, { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53" }, { "rel": "comments", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/comments" }, { "rel": "history", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/history" }, { "rel": "view", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/43d5ce15-0711-4603-8cc4-1b90c14d3136" }, { "rel": "items", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/items" }, { "rel": "attachments", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/attachments" }, { "rel": "export", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/export", "method": "POST" }, { "rel": "approvals", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/policiesByStage/approve" }, { "rel": "commits", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/policiesByStage/approve" }, { "rel": "collaborationInvitees", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/collaborationInvitees" }, { "rel": "participants", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/requestParticipants" }, { "rel": "lineage", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d00decfe-c188-422c-a498-3bf901498b53/lineage" } ], "validTransitionActions": [], "viewStatus": "ACTIVE", "ageInDays": 3, "createdByUser": { "id": "543197b1-6156-47cc-8891-874b7257d2d0", "userName": "demoadmin", "fullName": "Demo Admin", "firstName": "Demo", "lastName": "Admin", "emailAddresses": [], "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/543197b1-6156-47cc-8891-874b7257d2d0" } ], "nameInitials": "DA" }, "modifiedByUser": { "id": "543197b1-6156-47cc-8891-874b7257d2d0", "userName": "demoadmin", "fullName": "Demo Admin", "firstName": "Demo", "lastName": "Admin", "emailAddresses": [], "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/543197b1-6156-47cc-8891-874b7257d2d0" } ], "nameInitials": "DC" }, "owner": { "id": "d74a9c30-e809-41fd-9479-6537c32a592e", "userName": "demoadmin", "fullName": "Demo Admin", "firstName": "Demo", "lastName": "Admin", "emailAddresses": [], "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d74a9c30-e809-41fd-9479-6537c32a592e" } ], "nameInitials": "BD" }, "autoSubmitted": false } ], "hasMore": false, "totalResults": 1, "limit": 500, "count": 1 }