ItemTypes

GetItemTypeDetails

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
itemTypeUid required	string <uuid>

query Parameters

api-version

string

Responses

200

OK

get/api/companies/{companyUid}/item-types/{itemTypeUid}

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"parentUid": "00000000-0000-0000-0000-000000000000",
"description": "string",
"employees": [{"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"role": 1
}
],
"employeeGroup": [{"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"role": 1
}
],
"itemTypeProperties": [{"propertyName": "string",
"isRequired": true,
"regularExpresion": "string",
"dataType": 1,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"name": "string",
"imageType": 1,
"type": 1,
"accessInfo": 2,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}

DeleteItemType

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
itemTypeUid required	string <uuid>

query Parameters

api-version

string

Responses

204

No Content

delete/api/companies/{companyUid}/item-types/{itemTypeUid}

Request samples

C#
Java
Python
JavaScript
curl

UpdateItemTypeDetails

Securityoauth2

Request

path Parameters

companyUid required	string <uuid>
itemTypeUid required	string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

name required	string [ 0 .. 50 ] characters
parentUid	string <uuid>
type required	integer <int32> Enum: 1 2
image required	integer <int32> Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
description	string
required	Array of objects (Zalary.Models.ItemsAndAccess.ItemType.EmployeeInItemTypeRequest)
required	Array of objects (Zalary.Models.ItemsAndAccess.ItemType.EmployeeInItemTypeRequest)
required	Array of objects (Zalary.Models.ItemsAndAccess.ItemCategory.CreateItemTypePropertyRequest)

Responses

204

No Content

patch/api/companies/{companyUid}/item-types/{itemTypeUid}

Request samples

{"name": "string",
"parentUid": "00000000-0000-0000-0000-000000000000",
"type": 1,
"image": 1,
"description": "string",
"employees": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"employeeGroups": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"customFields": [{"name": "string",
"isRequired": true,
"regularExpresion": "string",
"dataType": 1,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

GetItemTypes

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

roles required	Array of integers <int32> Items Enum: 1 2 3 4 5 6
api-version	string

Responses

200

OK

get/api/companies/{companyUid}/item-types

Request samples

C#
Java
Python
JavaScript
curl

Response samples

200

{"totalRecords": 0,
"totalDisplayRecords": 0,
"data": [{"image": 1,
"numberOfItems": 0,
"numberOfCustomFields": 0,
"isUsed": true,
"parentUid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"imageType": 1,
"type": 1,
"accessInfo": 2,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

InsertItemType

Securityoauth2

Request

path Parameters

companyUid

required

string <uuid>

query Parameters

api-version

string

Request Body schema:
application/json

name required	string [ 0 .. 50 ] characters
parentUid	string <uuid>
type required	integer <int32> Enum: 1 2
image required	integer <int32> Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
description	string
required	Array of objects (Zalary.Models.ItemsAndAccess.ItemType.EmployeeInItemTypeRequest)
required	Array of objects (Zalary.Models.ItemsAndAccess.ItemType.EmployeeInItemTypeRequest)
required	Array of objects (Zalary.Models.ItemsAndAccess.ItemCategory.CreateItemTypePropertyRequest)

Responses

200

OK

post/api/companies/{companyUid}/item-types

Request samples

{"name": "string",
"parentUid": "00000000-0000-0000-0000-000000000000",
"type": 1,
"image": 1,
"description": "string",
"employees": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"employeeGroups": [{"uid": "00000000-0000-0000-0000-000000000000",
"role": 1
}
],
"customFields": [{"name": "string",
"isRequired": true,
"regularExpresion": "string",
"dataType": 1,
"uid": "00000000-0000-0000-0000-000000000000"
}
]
}

Response samples

200

{"parentUid": "00000000-0000-0000-0000-000000000000",
"description": "string",
"employees": [{"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"role": 1
}
],
"employeeGroup": [{"uid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"role": 1
}
],
"itemTypeProperties": [{"propertyName": "string",
"isRequired": true,
"regularExpresion": "string",
"dataType": 1,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"name": "string",
"imageType": 1,
"type": 1,
"accessInfo": 2,
"id": 0,
"uid": "00000000-0000-0000-0000-000000000000"
}

ItemTypes

GetItemTypeDetails

path Parameters

query Parameters

DeleteItemType

path Parameters

query Parameters

UpdateItemTypeDetails

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

GetItemTypes

path Parameters

query Parameters

InsertItemType

path Parameters

query Parameters

Request Body schema: application/jsontext/jsonapplication/x-www-form-urlencodedapplication/json

Request Body schema:
application/json

Request Body schema:
application/json