POST project/createItem?Token={Token}
Create project item in the system. Privilege "New" of licensed agenda "Projects.Items" required. No record permissions restriction implemented.
Request Information
Authorization
- Authorization by token required
Availability
- Method disabled by configuration
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
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
ProjectItemCreateReqName | Description | Type | Additional information |
---|---|---|---|
Code |
Unique identification of the project item in the system |
string |
Required String length: inclusive between 0 and 100 |
Description |
Project item description |
string |
Required String length: inclusive between 0 and 4000 |
Name |
The name of the project item |
string |
Required String length: inclusive between 0 and 100 |
Name2 |
Alternative name of the project item |
string |
Required String length: inclusive between 0 and 100 |
Shortcut |
The project item shortcut |
string |
Required String length: inclusive between 0 and 10 |
Identifier |
Identification of the project item |
string |
Required String length: inclusive between 0 and 100 |
Unit |
The project item unit |
byte |
Range: inclusive between 0 and 0 |
Request 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}
application/xml
<Request> <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> <Unit>0</Unit> </Request>
text/json
{ "Code": "sample string 1", "Description": "sample string 2", "Name": "sample string 3", "Name2": "sample string 4", "Shortcut": "sample string 5", "Identifier": "sample string 6", "Unit": 64 }
text/xml
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Code>sample string 1</Code> <Description>sample string 2</Description> <Name>sample string 3</Name> <Name2>sample string 4</Name2> <Shortcut>sample string 5</Shortcut> <Identifier>sample string 6</Identifier> <Unit>64</Unit> </Request>
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Processed with result: ExecOK |
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 | 1242 | Privilege New of agenda Projects.Items violated for [{0}] |
403 server refuses fo fulfill the request | 1 | Db operation failed, agenda missing priviliges |
403 server refuses fo fulfill the request | 2 | Db operation failed, record missing priviliges |
403 server refuses fo fulfill the request | 3 | Db operation failed, Record duplicity |
403 server refuses fo fulfill the request | 4 | Db operation failed, already changed by another user |
403 server refuses fo fulfill the request | 5 | Db operation failed, already deleted by another user |
403 server refuses fo fulfill the request | 6 | Db operation failed, database data consistence violation |
403 server refuses fo fulfill the request | 7 | Db operation failed, operation can not be executed because another problems occured |
403 server refuses fo fulfill the request | 8 | Db operation failed, licence violation |
403 server refuses fo fulfill the request | 1243 | The key ProjectItem.Code {0} is not unique |
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
BaseRespOfProjectItemCreateReqName | Description | Type | Additional information |
---|---|---|---|
Result | RequestResult |
None. |
|
Request | ProjectItemCreateReq |
None. |
Response Formats
application/json
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"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}}
application/xml
<Response> <Result> <Message>Processed with result: ExecOK</Message> <Code>0</Code> </Result> <Request> <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> <Unit>0</Unit> </Request> </Response>
text/json
{ "Result": { "Message": "sample string 1", "Code": 2, "ModelStateErr": [ "sample string 1", "sample string 2" ] }, "Request": { "Code": "sample string 1", "Description": "sample string 2", "Name": "sample string 3", "Name2": "sample string 4", "Shortcut": "sample string 5", "Identifier": "sample string 6", "Unit": 64 } }
text/xml
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Result> <Message>sample string 1</Message> <Code>2</Code> <ModelStateErr> <string>sample string 1</string> <string>sample string 2</string> </ModelStateErr> </Result> <Request> <Code>sample string 1</Code> <Description>sample string 2</Description> <Name>sample string 3</Name> <Name2>sample string 4</Name2> <Shortcut>sample string 5</Shortcut> <Identifier>sample string 6</Identifier> <Unit>64</Unit> </Request> </Response>