Assign a request to user
post
/epm/rest/v1/requests/assignRequest
Request
AssignRequestToUserCommandJson
Root Schema : Parameters for assigning a request
Type:
Show Source
object
-
comment:
string
Optional comment while assigning a request
-
requestNumber(required):
integer(int32)
Request Number for the request that is used for assignment
-
userName(required):
string
Name of the user who the request is being assigned to
Response
Supported Media Types
- application/json
201 Response
Request Assigned
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:
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 in body
401 Response
Unauthorized to assign requests
404 Response
Request not found
Examples
The following example shows how to assign a request to a user
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/assignRequest
Example of Request Body
The following shows an example of the request body in JSON format.
{ "requestNumber": 4137, "userName": "barry", "comment": "Assigning to Barry to complete and submit the request", }
Example of Response Body
The following shows an example of the response body in JSON format.
{ { "id": "9b578f8d-b7ae-4a43-a2f0-47b72e389363", "title": "Request 4137", "description": "Request for Departments created by Administrator .", "origin": "INTERACTIVE", "status": "DRAFT", "stage": "SUBMIT", "requestNumber": 4137, "timeCreated": "2022-11-28T22:50:08.912Z", "timeModified": "2022-11-28T22:50:36.946Z", "createdBy": "Administrator ", "modifiedBy": "Administrator ", "assignedTo": "Barry Dylan", "viewId": "bf218685-6038-48f2-9538-748bd97bc63d", "viewName": "Departments", "hasViewAccess": false, "links": [ { "rel": "addComment", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/comments", "method": "POST" }, { "rel": "addAttachment", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/attachments", "method": "POST" }, { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363" }, { "rel": "comments", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/comments" }, { "rel": "history", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/history" }, { "rel": "view", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/bf218685-6038-48f2-9538-748bd97bc63d" }, { "rel": "items", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/items" }, { "rel": "validAssignees", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/validAssignee" }, { "rel": "parseResults", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/parseResults", "method": "POST" }, { "rel": "attachments", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/attachments" }, { "rel": "export", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/export", "method": "POST" }, { "rel": "approvals", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/policiesByStage/approve" }, { "rel": "commits", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/policiesByStage/approve" }, { "rel": "copyNodes", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/copyNodes", "method": "POST" }, { "rel": "copyNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/copyNode", "method": "POST" }, { "rel": "addNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/addNode", "templated": true, "method": "POST" }, { "rel": "insertNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/insertNode", "templated": true, "method": "POST" }, { "rel": "deleteNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/deleteNode", "templated": true, "method": "POST" }, { "rel": "updateNodeProp", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/updateNodeProp", "templated": true, "method": "POST" }, { "rel": "clearNodeProp", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/clearNodeProp", "templated": true, "method": "POST" }, { "rel": "renameNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/renameNode", "templated": true, "method": "POST" }, { "rel": "moveNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/moveNode", "templated": true, "method": "POST" }, { "rel": "removeNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/removeNode", "templated": true, "method": "POST" }, { "rel": "reorderNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/edits/{nodeId}/reorderNode", "templated": true, "method": "POST" }, { "rel": "collaborationInvitees", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/collaborationInvitees" }, { "rel": "participants", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/requestParticipants" }, { "rel": "transactionSummaryByNode", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/requestTransactionSummary" }, { "rel": "lineage", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/9b578f8d-b7ae-4a43-a2f0-47b72e389363/lineage" } ], "consolidationRequestNumber": 0, "validTransitionActions": [ "SUBMIT" ], "viewStatus": "ACTIVE", "ageInDays": 0, "createdByUser": { "id": "d0b44daf-502b-4c27-9edb-3ac4bd7d1aee", "userName": "epm_default_cloud_admin", "fullName": "Administrator ", "firstName": "Administrator", "lastName": "", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d0b44daf-502b-4c27-9edb-3ac4bd7d1aee" } ], "nameInitials": "A", "dataManagerOnAny": false }, "modifiedByUser": { "id": "d0b44daf-502b-4c27-9edb-3ac4bd7d1aee", "userName": "epm_default_cloud_admin", "fullName": "Administrator ", "firstName": "Administrator", "lastName": "", "emailAddresses": [], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d0b44daf-502b-4c27-9edb-3ac4bd7d1aee" } ], "nameInitials": "A", "dataManagerOnAny": false }, "assignedToUser": { "id": "94dc32d0-47ff-43c1-b119-d2141c32dd54", "userName": "barry", "fullName": "Barry Dylan", "firstName": "Barry", "lastName": "Dylan", "emailAddresses": [], "links": [ { "rel": "self", "href": "http://localhost:8080/dmcs/ui-rest/v1/users/94dc32d0-47ff-43c1-b119-d2141c32dd54" }, { "rel": "profilePicture", "href": "http://localhost:8080/dmcs/ui-rest/v1/users/94dc32d0-47ff-43c1-b119-d2141c32dd54/profilePicture", "method": "GET" } ], "nameInitials": "BD", "dataManagerOnAny": false }, "subscriptions": [], "autoSubmitted": false } }