Jump to

• Request
• Response
• Examples

Transition request to a new status

post

/epm/rest/v1/requests/{requestId}/transitions

Request

Path Parameters

• requestId: string(uuid)

Body ()

transition action

Root Schema : TransitionJson

Type: object

Show Source

• action: string
  Allowed Values: [ "SUBMIT", "APPROVE", "PUSHBACK", "REJECT", "WITHDRAW", "RECALL", "COMMIT" ]

  transition action

  Example: SUBMIT
• comment(optional): string
  comment

  Example: Looks OK.
• transitionWithWarning(optional): boolean
  Indicates that the transition to the next stage can proceed even if there are custom validation failures, as long as all failures are WARNING severity.

{
    "type":"object",
    "required":[
        "action"
    ],
    "properties":{
        "action":{
            "type":"string",
            "example":"SUBMIT",
            "description":"transition action",
            "enum":[
                "SUBMIT",
                "APPROVE",
                "PUSHBACK",
                "REJECT",
                "WITHDRAW",
                "RECALL",
                "COMMIT"
            ]
        },
        "transitionWithWarning":{
            "type":"boolean",
            "description":"Indicates that the transition to the next stage can proceed even if there are custom validation failures, as long as all failures are WARNING severity."
        },
        "comment":{
            "type":"string",
            "example":"Looks OK.",
            "description":"comment"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted, transition processing

400 Response

Error in body

403 Response

Forbidden

404 Response

Not Found

Back to Top

Examples

The following example shows how to transition 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' \
  https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/transitions \
  -d @example_request_payload.json

Example of Request Body

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

{
    "action": "APPROVE",
    "comment": "This request looks good to me.",
    "transitionWithWarning": false
}

Example of Response Body

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

{
  "links": [
    {
      "rel": "results",
      "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/665f8de2-ef1d-41aa-ade7-7dfcd6196cba"
    }
  ]
}

Back to Top