Get Request Header

This REST API allows users to retrieve the header details of a request.

Endpoint Details

URL Structure

http(s)://<EPMWARE_URL>/service/api/request/get_header

Method

GET

Parameters

Parameter	Type	Required	Description
`requestId`	Query	Yes	Request ID

Request Examples

Using curl

curl GET 'https://demo.epmwarecloud.com/service/api/request/get_header?requestId=1444' \
  -H 'Authorization: Token 15388ad5-c9af-4cf3-af47-8021c1ab3fb7'

Response Format

Successful Response

{
  "id": 1444,
  "requestTypeCode": "M",
  "requestType": "Metadata",
  "requestedBy": "JSMITH",
  "requestorUserId": 286,
  "requestorFirstName": "John",
  "requestorLastName": "Smith",
  "requestorEmailAddress": "john.smith@example.com",
  "requestDate": "2026-08-12T13:39:57Z",
  "dueDate": "2026-08-22T13:39:57Z",
  "status": "S",
  "requestStatus": "Submitted",
  "description": "Add new accounts for FY27",
  "priorityCode": "S",
  "priority": "Standard",
  "wfId": 81,
  "wfCode": "001",
  "wfName": "Standard Approval",
  "wfCycleId": 3454,
  "wfStage": "Review",
  "wfStatus": "Pending Review",
  "pendingActionFrom": "Finance Reviewers",
  "requestCompletionDays": null,
  "taskId": null,
  "udf1": "FIN",
  "udf2": null,
  "udf3": "N",
  "udf1Meaning": "Finance",
  "udf2Meaning": null,
  "udf3Meaning": "No",
  "bulkUploadId": null,
  "isBulkUploadRunning": false,
  "bulkUploadStatus": null,
  "buValidationTaskId": null,
  "buSubmitTaskId": null,
  "secClassId": 1
}

Response Fields

Field	Type	Description
`id`	Long	Request ID
`requestTypeCode`	String	Request type code (e.g. M)
`requestType`	String	Request type name (e.g. Metadata)
`requestedBy`	String	Requestor user name
`requestorUserId`	Long	Requestor user ID
`requestorFirstName`	String	Requestor first name
`requestorLastName`	String	Requestor last name
`requestorEmailAddress`	String	Requestor email address
`requestDate`	Date	Date the request was created
`dueDate`	Date	Due date
`status`	String	Request status code: N New, S Submitted, C Completed, J Rejected, X Cancelled, E Failed
`requestStatus`	String	Request status meaning
`description`	String	Request description
`priorityCode`	String	Priority code
`priority`	String	Priority meaning (e.g. Standard, Urgent)
`wfId`	Long	Workflow ID
`wfCode`	String	Workflow code
`wfName`	String	Workflow name
`wfCycleId`	Long	Current workflow cycle ID (null until submitted)
`wfStage`	String	Current workflow stage name (only when status = S)
`wfStatus`	String	Workflow status (e.g. Pending Submission, Completed)
`pendingActionFrom`	String	Who the request is waiting on (only when status = S)
`requestCompletionDays`	Long	Days taken to complete (only when status = C)
`taskId`	Long	Task ID
`udf1` / `udf2` / `udf3`	String	User defined field values
`udf1Meaning` / `udf2Meaning` / `udf3Meaning`	String	Lookup meaning of the UDF value (the value itself when it is not a lookup)
`bulkUploadId`	Long	Bulk upload ID, when created by bulk upload
`isBulkUploadRunning`	Boolean	True while a bulk upload is running
`bulkUploadStatus`	String	Bulk upload status
`buValidationTaskId`	Long	Bulk upload validation task ID
`buSubmitTaskId`	Long	Bulk upload submit task ID
`secClassId`	Long	Security class ID of the workflow

← Request | Get Request Notes →