GET api/CategoryTypes/UserCategoryTypes?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": "d74b83b7-bf80-4010-ae9c-def46f5df45d",
"Name": "sample string 2"
},
{
"Identity": "d74b83b7-bf80-4010-ae9c-def46f5df45d",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
]
}
],
"Identity": "a1d23efd-79c5-4372-918c-365840d62a4d",
"Name": "sample string 4"
},
{
"Description": "sample string 1",
"IsAdditionalFilter": true,
"ParentCategoryTypeIdentities": [
{
"Identity": "d74b83b7-bf80-4010-ae9c-def46f5df45d",
"Name": "sample string 2"
},
{
"Identity": "d74b83b7-bf80-4010-ae9c-def46f5df45d",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "206b25d7-a369-4e68-9b41-a71ab801eed8",
"Name": "sample string 2"
}
]
}
],
"Identity": "a1d23efd-79c5-4372-918c-365840d62a4d",
"Name": "sample string 4"
}
]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.