ProJob - Get production display metadata

API Url

Returns the display configuration (page timing, refresh interval) and the ordered list of columns with alignment hints. The column list reflects the last calculated snapshot.

GET

http://localhost:16010/ProMarkREST/web/ProJob/production-display/{id}/metadata

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
id	Number	ObjectID of the production display configuration, or the literal string me to resolve the display for the authenticated user (requires role Admin).

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
columns	Object[]	Ordered column definitions.
colId	Number	Column index (1-based).
label	String	Column header text.
rightAlign	Boolean	true = numeric/right-aligned column.
metadata	Object
lastRefreshTime	Datetime	When the snapshot was last calculated. Null if never.
objectId	Number	ObjectID of the linked production display configuration.
pageSize	Number	Rows to show per page.
pageTimeout	Number	Seconds before paging to next page.
refreshTimeout	Number	Seconds between data refreshes.
title	String	Display header text.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.