GET api/CategoryTypes?includeAdditional={includeAdditional}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| includeAdditional | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of CategoryType| Name | Description | Type | Additional information |
|---|---|---|---|
| Description | string |
None. |
|
| IsAdditionalFilter | boolean |
None. |
|
| ParentCategoryTypeIdentities | Collection of NamedObject |
None. |
|
| ReadPermissionGroups | Collection of PermissionObject |
None. |
|
| WritePermissionGroups | Collection of PermissionObject |
None. |
|
| BookPermissionGroups | Collection of PermissionObject |
None. |
|
| RequestPermissionGroups | Collection of PermissionWithApproval |
None. |
|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Description": "sample string 1",
"IsAdditionalFilter": true,
"ParentCategoryTypeIdentities": [
{
"Identity": "2f950ad3-8f2c-47dd-914f-e99aba56d90b",
"Name": "sample string 2"
},
{
"Identity": "2f950ad3-8f2c-47dd-914f-e99aba56d90b",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
]
}
],
"Identity": "ca105a15-377f-4146-924d-c621bb73ced8",
"Name": "sample string 4"
},
{
"Description": "sample string 1",
"IsAdditionalFilter": true,
"ParentCategoryTypeIdentities": [
{
"Identity": "2f950ad3-8f2c-47dd-914f-e99aba56d90b",
"Name": "sample string 2"
},
{
"Identity": "2f950ad3-8f2c-47dd-914f-e99aba56d90b",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "1c47c510-d58d-469b-8ba9-2c7a0cb35f3f",
"Name": "sample string 2"
}
]
}
],
"Identity": "ca105a15-377f-4146-924d-c621bb73ced8",
"Name": "sample string 4"
}
]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.