Create a new request

post

/epm/rest/v1/requests

Request

Body ()
Root Schema : CreateRequestCommandJson
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

Request created
Headers
Body ()
Root Schema : Request
Type: object
A Request models changes to apply to a View
Show Source
Nested Schema : User
Type: object
Show Source
Nested Schema : validTransitionActions
Type: array
Read Only: true
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 : TimeZone
Type: object
Show Source

400 Response

Error in body

404 Response

View not found
Back to Top

Examples

The following example shows how to create a request by submitting a post request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X POST -H 'Content-Type: application/json' -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "viewUri": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10",
    "title": "Automated Request",
    "description": "A requested created with the automation API",
    "notes": ""
}

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",
  "requestNumber": 1043,
  "timeCreated": "2018-04-02T18:24:05.890Z",
  "timeModified": "2018-04-02T18:24:05.890Z",
  "timeSubmitted": "2018-04-02T18:24:05.890Z",
  "createdBy": "demoadmin",
  "submittedBy": "demoadmin",
  "notes": "",
  "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": [
    "COMMIT"
  ],
  "permittedActions": [
    "DELETE",
    "EDIT"
  ]
}
Back to Top