ProJect - Get project extra info values
API Url
Used for loading values of project extra info.
http://localhost:16010/ProMarkREST/rest/ProJect/extra-info/{info_id}/values
Permissions: user
Path parameters
| Field | Type | Description |
|---|---|---|
| info_id | String | Project extra info Id |
Query parameters
| Field | Type | Description |
|---|---|---|
descriptionoptional | String | Return extra info values where value description matches this description. |
expandoptional | String | Expand schema according to URI. schema |
fieldsoptional | String | List of the fields to be returned, If not defined returns all fields. |
filteroptional | String | Filter fields and its values and conditions. |
idoptional | String | Return extra info values where value Id starts with this id. |
noSchemaoptional | Boolean | true = The schema property/object will not be returned. Default is false. |
queryoptional | Number | Unique identifier of the server query. Initially, it will be 0, then it will be the query id sent by the server. Used in server-side paging. |
skipoptional | Number | Skip a certain number of records. Used in server-side paging. |
takeoptional | Number | Limit the number of records to return. Used in server-side paging. |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| title | String | Field title/header. |
| type | String | The field variable type. "string""number""date""boolean" |
| schema | String | The meta schema URI. Not sent when 'expand=schema'. |
| any | Object | Field name, depending on schema type (*: any). It's the object containging settings for this field. |
| fields | Object | Object containing the field objects. |
| id | String | The field name to use as internal id (value field). |
| objectName | String | The json object name containing the data. |
| text | String | The description to show (used for drop-down, combo-box etc.). |
| values | Object[] | Collection of project extra info values. |
| description | String | Extra info value description. |
| id | String | Extra info value Id. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"data": {"values": [{"id": "","description": "<Not Used>"},{"id": "SBI","description": "Department, Hudson Bay"},{"id": "SBII","description": "Department Lock Ness"},{"id": "SBIII","description": "Department SB"},{"id": "SR1","description": "sr Department 1"}],"schema": "/ProJect/schemas/extra-info-values"},"errorCode": 0,"errorMessage": ""}}