GET project/getItem?Code={Code}&Token={Token}
Retrieve project item data. Application privilege "View" for licensed agenda "Project.Items" required. Data may also be restricted by record permission "Project.Items"
Request Information
Authorization
- Authorization by token required
Availability
- Method disabled by configuration
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Code |
Unique identification of the person in the system |
string |
Required String length: inclusive between 0 and 100 |
Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
401 unauthorized | 1000 | Token {0} not found |
401 unauthorized | 1001 | Token {0} already expired |
401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
401 unauthorized | 1008 | Request rate policy violated for [{0}] |
403 server refuses fo fulfill the request | 1240 | Privilege View of agenda Projects.Items violated for [{0}] |
403 server refuses fo fulfill the request | 1246 | Record permission View of agenda Projects.Items violated for [{0}] |
404 required resource does not exist on the server | 1241 | ProjectItem [{0}] not found |
415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
500 internal error | Server exception description |
Resource Description
ProjectItemGetRespName | Description | Type | Additional information |
---|---|---|---|
Code |
Unique identification of the project item in the system |
string |
None. |
Description |
Project item description |
string |
None. |
Name |
The name of the project item |
string |
None. |
Name2 |
Alternative name of the project item |
string |
None. |
Shortcut |
The project item shortcut |
string |
None. |
Identifier |
Identification of the project item |
string |
None. |
Unit |
The project item unit |
byte |
None. |
TimeLastChange |
The last change time of the data record. Can be used to check manual modification of data record |
date |
None. |
Response Formats
application/json
{"Code":"CODE 1001","Description":"Description of the item 1001","Name":"Name of the item 1001","Name2":"Another Name of the item 1001","Shortcut":"Shortcut of the item 1001","Identifier":"Identifier of the item 1001","Unit":0,"TimeLastChange":"\/Date(1737612728468)\/"}
application/xml
<Response> <Code>CODE 1001</Code> <Description>Description of the item 1001</Description> <Name>Name of the item 1001</Name> <Name2>Another Name of the item 1001</Name2> <Shortcut>Shortcut of the item 1001</Shortcut> <Identifier>Identifier of the item 1001</Identifier> <TimeLastChange>2025-01-23T06:12:08.4687321Z</TimeLastChange> </Response>
text/json
{ "Code": "sample string 1" }
text/xml
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Code>sample string 1</Code> </Response>