- style
GET jobs/:job_id/extension/values
- Kurt Wagner (Unlicensed)
IN DEVELOPMENT
Resource URL
Returns an array of extension values for a given job. Extension values are the custom fields you apply to different types of objects.
GET /jobs/:id/extension/values
Parameters
Table of allowed parameters.
| _page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. |
|---|---|---|
| _limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
| _offset | unsigned int | The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page. |
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
Handling the response
Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.
| id | unsigned int | Unique id assigned to the extension value |
|---|---|---|
| field_type | string | 'text', 'textbox', 'int', 'date', 'date_time', 'float', 'certify', 'fixed_select', 'flexible_select', 'multi_select', 'lookup', 'currency', 'hyperlink' or 'contributor' |
| field_name | string | The title you have the extension values structure. e.g, "Uploaded?" |
| value * | string | *Â Only visible if type is text, textbox, float, fixed_select, flexible_select, multi_select, currency or hyperlink. |
| value_id * | unsigned | *Â Only visible if type is lookup or contributor. It will contain the unique id for the item being looked up or the contributor's unique id. |
| value_date * | unix timestamp | *Â Only visible if field type is date or date_time. |
| value_type * | string | *Â Only visible if field type is lookup. It will contain the type of object being looked up. e.g, company or job. |
| link_id | unsigned | ID given to the object the extension value belongs to. e.g, it may be against a job with id 12. Link id would then be 12. |
| link_type | string | Name of the type of object the extension value belongs to. e.g, job or company. |
| date_modified | unix timestamp | Unix timestamp for the date the extension value was last modified. |
| modified_by | unsigned | The staff id of the user who last modified the extension value. |
| modified_by() | object | The staff object of the user who last modified the extension value. For details on optional parameters that can be placed within the parenthesis, please see the GET staff/:id endpoint. |
| structure | unsigned | All extension values utilise an extension structure. This attribute is the unique id given to an extension structure. In the future you will be able to use this to hit the structures details directly. |