PATCH/projects/api/v3/customitems/{customItemId}.json
Edit an existing custom item.
Long description explaining the endpoint.
Path Params
- Name
customItemId- Type
- integer
- required
- Description
Body Params
Request contains information of a customitem to be created or updated.
- Name
customItem- Type
- object
- Description
- CustomItem contains all the information returned from a customitem.
- Name
customItemOptions- Type
- object
Responses
- Code
- 201
- Type
- object
- Schema
- Description
- 201 Created
Response contains information about a specific customitem.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
- Code
- 403
- Type
- object
- Schema
- Description
- 403 Forbidden
ErrorResponse defines how []Error should be marshaled to JSON.
201 Created
Response
{
"customItem": {
"createdAt": "string",
"createdBy": {
"id": 0,
"meta": {},
"type": "string"
},
"deletedAt": "string",
"deletedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"displayName": "string",
"fields": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"id": 0,
"labelPlural": "string",
"labelSingular": "string",
"relations": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"sections": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"state": "string",
"updatedAt": "string",
"updatedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"views": [
{
"id": 0,
"meta": {},
"type": "string"
}
]
},
"included": {
"customItemFields": {
"additionalProp": {
"createdAt": "string",
"createdBy": {
"id": 0,
"meta": {},
"type": "string"
},
"customItemId": 0,
"definition": "string",
"deletedAt": "string",
"deletedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"displayName": "string",
"displayOrder": 0,
"id": 0,
"options": [
{
"color": "string",
"displayOrder": 0,
"id": 0,
"label": "string",
"twId": "string"
}
],
"state": "string",
"twId": "string",
"twType": "string",
"type": "string",
"updatedAt": "string",
"updatedBy": {
"id": 0,
"meta": {},
"type": "string"
}
}
},
"customItemViews": {
"additionalProp": {
"configuration": "string",
"createdAt": "string",
"createdBy": {
"id": 0,
"meta": {},
"type": "string"
},
"customItemId": 0,
"deletedAt": "string",
"deletedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"displayName": "string",
"displayOrder": 0,
"id": 0,
"state": "string",
"updatedAt": "string",
"updatedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"viewTypeId": 0
}
},
"users": {
"additionalProp": {
"avatarUrl": "string",
"canAccessPortfolio": true,
"canAddProjects": true,
"canManagePortfolio": true,
"company": {
"id": 0,
"meta": {},
"type": "string"
},
"companyId": 0,
"companyRoleId": 0,
"createdAt": "string",
"createdBy": {
"id": 0,
"meta": {},
"type": "string"
},
"deleted": true,
"email": "string",
"firstName": "string",
"id": 0,
"isAdmin": true,
"isClientUser": true,
"isPlaceholderResource": true,
"isServiceAccount": true,
"jobRoles": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"lastLogin": "string",
"lastName": "string",
"lengthOfDay": 0,
"meta": {},
"skills": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"teams": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"timezone": "string",
"title": "string",
"type": "string",
"updatedAt": "string",
"updatedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"userCost": 0,
"userRate": 0,
"userRates": {
"additionalProp": {
"amount": 0,
"currency": {
"id": 0,
"meta": {},
"type": "string"
}
}
},
"workingHour": {
"id": 0,
"meta": {},
"type": "string"
},
"workingHoursId": 0
}
}
}
}