ProJect - Get project extra information

API Url

Used for loading project extra information.

GET
http://localhost:16010/ProMarkREST/rest/ProJect/extra-info

Permissions: user

Query parameters

FieldTypeDescription
categoryIdoptionalString

Category ID.

departmentIdoptionalString

Department ID.

profileIdoptionalString

Project profile ID.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    infoObject[]

Collection of project extrainfo.

      descriptionString

Extra info description.

      dimensionNumber

Extra info dimension.

      fixedValuesBoolean

TRUE if "Validate Input" else FALSE.

      idString

project extra info ID.

      mandatoryBoolean

TRUE if "Input Mandatory" else FALSE.

  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": {
"extraInfo": [
{
"id": "DEPT:",
"description": "Department",
"dimension": 1,
"mandatory": false,
"fixedValues": true
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.