Query requests

get

/epm/rest/v1/requests/byName/query

Request

Query Parameters
  • Collection Format: multi
    Expands the response with additional information
    • Allowed Values: [ "workflow" ]
  • From Date in Epoch time, Difference between from and to date can be max of 90 days
    Allowed Values: [ "Epoch time eg: 1659339021" ]
  • Number of days in the past from the current date. Maximum value is 90.
    Allowed Values: [ "Non zero positive integer" ]
  • Collection Format: multi
    Activity names separated by comma
    • Allowed Values: [ "Assigned", "Collaborated", "Submitted", "Invited", "Contributed", "Managed" ]
  • Collection Format: multi
    Owner names separated by comma
    • Allowed Values: [ "Name of the owner" ]
  • Collection Format: multi
    Priorities separated by comma
    • Allowed Values: [ "None", "Low", "Medium", "High" ]
  • Collection Format: multi
    Request Number
    • Allowed Values: [ "Nonzero positive integer" ]
  • Collection Format: multi
    Request types separated by comma
    • Allowed Values: [ "Interactive", "Subscription", "Import", "Consolidation" ]
  • Collection Format: multi
    Stage of the request separated by comma
    • Allowed Values: [ "Submit", "Approved", "Commit", "Closed" ]
  • Collection Format: multi
    Status separated by comma
    • Allowed Values: [ "Draft", "In Flight", "Recalled", "Pushed Back", "Completed", "Rejected", "Blocked", "Consolidated" ]
  • To Date in Epoch time, Difference between from and to date can be max of 90 days
    Allowed Values: [ "Epoch time eg: 1659339021" ]
  • Collection Format: multi
    View names separated by comma
    • Allowed Values: [ "Name of the view in application" ]
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ItemsRequest
Type: object
Show Source
Nested Schema : items
Type: array
Read Only: true
Show Source
Nested Schema : Request
Type: object
A Request models changes to apply to a View
Show Source
Nested Schema : approvalUsers
Type: array
Read Only: true
Show Source
Nested Schema : User
Type: object
Show Source
Nested Schema : commitUsers
Type: array
Read Only: true
Show Source
Nested Schema : IdNameDescription
Type: object
Show Source
Nested Schema : inviteeUsers
Type: array
Read Only: true
Show Source
Nested Schema : subscriptions
Type: array
Read Only: true
Show Source
Nested Schema : validTransitionActions
Type: array
Read Only: true
Show Source
  • Allowed Values: [ "SUBMIT", "APPROVE", "PUSHBACK", "REJECT", "WITHDRAW", "RECALL", "COMMIT", "CLOSE" ]
Nested Schema : artifactAssignments
Type: array
Show Source
Nested Schema : associatedRoles
Type: array
Show Source
Nested Schema : emailAddresses
Type: array
Show Source
Nested Schema : Preferences
Type: object
Show Source
Nested Schema : ArtifactAssignment
Type: object
Show Source
Nested Schema : Artifact
Type: object
Show Source
Nested Schema : Role
Type: object
Show Source
Nested Schema : TimeZone
Type: object
Show Source

400 Response

Error Response

404 Response

Not Found
Back to Top

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
}

Back to Top