ProJect - Get project list

API Url

Used for loading projects.

GET

http://localhost:16010/ProMarkREST/rest/ProJect/projects

Permissions: user

Query parameters

Field	Type	Description
deptId`optional`	String	Department ID. Use for showing only projects having activities in this department.
empId`optional`	String	Get projects for this employee ID. If not sent, it's the current employee.
expand`optional`	String	Expand schema according to URI. Default value: `schema`
fields`optional`	String	List of fields to return, if empty returns all fields.
filter`optional`	String	filter fields and its values and conditions.
noSchema`optional`	Boolean	true = The schema property/object will not be returned. Default is false.
onlyUserReg`optional`	Boolean	Only projects assign to the user in the period 'regFrom' - 'regTo' are included.
query`optional`	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.
regFrom`optional`	Date	Registration From date. Used for getting only projects having registrations in the period 'regFrom' - 'regTo'.
regTo`optional`	Date	Registration To date. Used for getting only projects having registrations in the period 'regFrom' - 'regTo'.
setRecentOrder`optional`	Boolean	true = Field 'mruOrder' will be assigned with the most recently used items (1-15). All other items will have 'mruOrder' = 100.
skip`optional`	Number	Skip a certain number of records. Used in server-side paging.
take`optional`	Number	Limit the number of records to return. Used in server-side paging.
userId`optional`	String	User ID. If supplied, then department restrictions of the user will be applied.

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. Allowed values:`"string""number""date""boolean"`
projects	Object[]	Collection of projects.
createBy	String	Project created by.
created	DateTime	Project created datetime.
description	String	project description.
divisionId	String	Division Id.
end	Date	Planned end time.
id	String	project ID.
lastChanged	DateTime	Last changed datetime.
lastChangedBy	String	Last changed by.
mruOrder	Number	Sort by this field. Most recently used projects will have value 1-15, all other projects will have value 100.
plannedTime	Number	Planned project time.
ref1	String	project reference1.
ref2	String	project reference2.
ref3	String	project reference3.
start	Date	Planned start date
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.).
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "projects": [
            {
                "id": "FIXED2",
                "description": "Fixed project",
                "created": "2017-01-20T15:36:29.000",
                "createdBy": "SBA",
                "lastChanged": "2017-01-20T15:36:29.000",
                "lastChangedBy": "SBA",
                "mruOrder": 100
            }
         ],
         "schema": "/ProJect/schemas/project"
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

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.