ProJect - Get project extra info values

API Url

Used for loading values of project extra info.

GET
http://localhost:16010/ProMarkREST/rest/ProJect/extra-info/{info_id}/values

Permissions: user

Path parameters

FieldTypeDescription
info_idString

Project extra info Id

Query parameters

FieldTypeDescription
descriptionoptionalString

Return extra info values where value description matches this description.

expandoptionalString

Expand schema according to URI.

Default value: schema
fieldsoptionalString

List of the fields to be returned, If not defined returns all fields.

filteroptionalString

Filter fields and its values and conditions.

idoptionalString

Return extra info values where value Id starts with this id.

noSchemaoptionalBoolean

true = The schema property/object will not be returned. Default is false.

queryoptionalNumber

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.

skipoptionalNumber

Skip a certain number of records. Used in server-side paging.

takeoptionalNumber

Limit the number of records to return. Used in server-side paging.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

      titleString

Field title/header.

      typeString

The field variable type.

Allowed values:"string""number""date""boolean"
    schemaString

The meta schema URI. Not sent when 'expand=schema'.

      anyObject

Field name, depending on schema type (*: any). It's the object containging settings for this field.

      fieldsObject

Object containing the field objects.

      idString

The field name to use as internal id (value field).

      objectNameString

The json object name containing the data.

      textString

The description to show (used for drop-down, combo-box etc.).

    valuesObject[]

Collection of project extra info values.

      descriptionString

Extra info value description.

      idString

Extra info value Id.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"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": ""
}
}