Create a new request
post
/epm/rest/v1/requests
Request
Root Schema : CreateRequestCommandJson
Type:
Show Source
object
-
description(optional):
string
The description for the request being created.
-
notes(optional):
string
Notes for the request being created.
-
origin(optional):
string
Allowed Values:
[ "INTERACTIVE" ]
The Origin of a request, currently only Interactive is supported. -
title(optional):
string
The title for the request being created.
-
viewUri:
string
The View Uri that we will be creating a request for.
Response
Supported Media Types
- application/json
201 Response
Request created
Headers
-
Location: string
URL of the created request
Root Schema : Request
Type:
object
A Request models changes to apply to a View
Show Source
-
actionCount(optional):
integer(int32)
Read Only:
true
-
ageInDays(optional):
integer(int64)
Read Only:
true
-
approvalUsers(optional):
array approvalUsers
Read Only:
true
-
assignedTo(optional):
string
Read Only:
true
This property is now deprecated and will be removed in 10/2020. Use assignedToUser instead. -
assignedToUser(optional):
object User
-
attachmentCount(optional):
integer(int32)
Read Only:
true
-
autoSubmitted(optional):
boolean
-
blockedUntil(optional):
integer(int64)
Read Only:
true
-
commentCount(optional):
integer(int32)
Read Only:
true
-
commitUsers(optional):
array commitUsers
Read Only:
true
-
consolidationRequest(optional):
object IdNameDescription
-
consolidationRequestNumber(optional):
integer(int32)
Read Only:
true
-
consolidationRequestStatus(optional):
string
Read Only:
true
Allowed Values:[ "DRAFT", "IN_FLIGHT", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
-
createdBy(optional):
string
Read Only:
true
This property is now deprecated and will be removed in 10/2020. Use createdByUser instead. -
createdByUser(optional):
object User
-
description(optional):
string
Read Only:
true
-
hasViewAccess(optional):
boolean
Read Only:
true
-
id(optional):
string(uuid)
Read Only:
true
-
initialSubmit(optional):
integer(int64)
Read Only:
true
-
inviteeUsers(optional):
array inviteeUsers
Read Only:
true
-
itemCount(optional):
integer(int32)
Read Only:
true
-
links(optional):
array links
Read Only:
true
-
modifiedBy(optional):
string
Read Only:
true
This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead. -
modifiedByUser(optional):
object User
-
notes(optional):
string
Read Only:
true
-
origin(optional):
string
Read Only:
true
Allowed Values:[ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
-
owner(optional):
object User
-
requestNumber(optional):
integer(int32)
Read Only:
true
-
requestType(optional):
string
Read Only:
true
Allowed Values:[ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
-
sourceRequest(optional):
object IdNameLink
-
stage(optional):
string
Read Only:
true
Allowed Values:[ "SUBMIT", "REVIEW", "ENRICH", "APPROVE", "COMMIT", "CLOSED" ]
-
status(optional):
string
Read Only:
true
Allowed Values:[ "DRAFT", "IN_FLIGHT", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
-
submittedBy(optional):
string
Read Only:
true
This property is now deprecated and will be removed in 10/2020. Use submittedByUser instead. -
submittedByUser(optional):
object User
-
subscriptions(optional):
array subscriptions
Read Only:
true
-
timeCreated(optional):
integer(int64)
Read Only:
true
-
timeModified(optional):
integer(int64)
Read Only:
true
-
timeSubmitted(optional):
integer(int64)
Read Only:
true
-
title(optional):
string
Read Only:
true
-
validationErrorCount(optional):
integer(int32)
Read Only:
true
-
validTransitionActions(optional):
array validTransitionActions
Read Only:
true
-
valWarningCountOnClose(optional):
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(optional):
string(uuid)
Read Only:
true
-
viewName(optional):
string
Read Only:
true
-
viewStatus(optional):
string
Read Only:
true
Allowed Values:[ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
Nested Schema : User
Type:
Show Source
object
-
artifactAssignments(optional):
array artifactAssignments
-
associatedRoles(optional):
array associatedRoles
-
dataManagerOnAny(optional):
boolean
-
emailAddresses(optional):
array emailAddresses
-
epmIdleSessionTimeout(optional):
integer(int32)
-
firstName(optional):
string
-
fullName(optional):
string
-
grantPermission(optional):
string
Allowed Values:
[ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
-
homePageLayoutName(optional):
string
-
id(optional):
string(uuid)
-
lastName(optional):
string
-
links(optional):
array links
-
nameInitials(optional):
string
-
preferences(optional):
object Preferences
-
ssoToken(optional):
string
-
userName(optional):
string
Nested Schema : validTransitionActions
Type:
array
Read Only:
Show Source
true
-
Array of:
string
Allowed Values:
[ "SUBMIT", "APPROVE", "PUSHBACK", "REJECT", "WITHDRAW", "RECALL", "COMMIT" ]
Nested Schema : Artifact
Type:
Show Source
object
-
id(optional):
string(uuid)
-
name(optional):
string
-
type(optional):
string
Allowed Values:
[ "CLUSTER", "CARD" ]
400 Response
Error in body
404 Response
View not found
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" ] }