PUT api/CategoryTypes/{id}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | string |
Required |
Body Parameters
CategoryTypeName | Description | Type | Additional information |
---|---|---|---|
Description | string |
None. |
|
IsAdditionalFilter | boolean |
None. |
|
ParentCategoryTypeIdentities | Collection of NamedObject |
None. |
|
ReadPermissionGroups | Collection of NamedObject |
None. |
|
WritePermissionGroups | Collection of NamedObject |
None. |
|
Identity | globally unique identifier |
None. |
|
Name | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Description": "sample string 1", "IsAdditionalFilter": true, "ParentCategoryTypeIdentities": [ { "Identity": "ab715f7f-39be-470b-a51d-858454ef6003", "Name": "sample string 2" }, { "Identity": "ab715f7f-39be-470b-a51d-858454ef6003", "Name": "sample string 2" } ], "ReadPermissionGroups": [ { "Identity": "ab715f7f-39be-470b-a51d-858454ef6003", "Name": "sample string 2" }, { "Identity": "ab715f7f-39be-470b-a51d-858454ef6003", "Name": "sample string 2" } ], "WritePermissionGroups": [ { "Identity": "ab715f7f-39be-470b-a51d-858454ef6003", "Name": "sample string 2" }, { "Identity": "ab715f7f-39be-470b-a51d-858454ef6003", "Name": "sample string 2" } ], "Identity": "ff311e81-c490-49eb-8169-d798b12cec1f", "Name": "sample string 4" }
application/xml, text/xml
Sample:
<CategoryType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">ff311e81-c490-49eb-8169-d798b12cec1f</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <ReadPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>ab715f7f-39be-470b-a51d-858454ef6003</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>ab715f7f-39be-470b-a51d-858454ef6003</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ReadPermissionGroups> <WritePermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>ab715f7f-39be-470b-a51d-858454ef6003</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>ab715f7f-39be-470b-a51d-858454ef6003</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </WritePermissionGroups> <Description>sample string 1</Description> <IsAdditionalFilter>true</IsAdditionalFilter> <ParentCategoryTypeIdentities xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>ab715f7f-39be-470b-a51d-858454ef6003</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>ab715f7f-39be-470b-a51d-858454ef6003</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ParentCategoryTypeIdentities> </CategoryType>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CategoryTypeName | Description | Type | Additional information |
---|---|---|---|
Description | string |
None. |
|
IsAdditionalFilter | boolean |
None. |
|
ParentCategoryTypeIdentities | Collection of NamedObject |
None. |
|
ReadPermissionGroups | Collection of NamedObject |
None. |
|
WritePermissionGroups | Collection of NamedObject |
None. |
|
Identity | globally unique identifier |
None. |
|
Name | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Description": "sample string 1", "IsAdditionalFilter": true, "ParentCategoryTypeIdentities": [ { "Identity": "8839006a-8b3e-4ee3-8a58-b1dc0050dbd2", "Name": "sample string 2" }, { "Identity": "8839006a-8b3e-4ee3-8a58-b1dc0050dbd2", "Name": "sample string 2" } ], "ReadPermissionGroups": [ { "Identity": "8839006a-8b3e-4ee3-8a58-b1dc0050dbd2", "Name": "sample string 2" }, { "Identity": "8839006a-8b3e-4ee3-8a58-b1dc0050dbd2", "Name": "sample string 2" } ], "WritePermissionGroups": [ { "Identity": "8839006a-8b3e-4ee3-8a58-b1dc0050dbd2", "Name": "sample string 2" }, { "Identity": "8839006a-8b3e-4ee3-8a58-b1dc0050dbd2", "Name": "sample string 2" } ], "Identity": "a4a54cb1-aab1-4331-a78b-24bf5a7e2c00", "Name": "sample string 4" }
application/xml, text/xml
Sample:
<CategoryType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">a4a54cb1-aab1-4331-a78b-24bf5a7e2c00</Identity> <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name> <ReadPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>8839006a-8b3e-4ee3-8a58-b1dc0050dbd2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>8839006a-8b3e-4ee3-8a58-b1dc0050dbd2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ReadPermissionGroups> <WritePermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>8839006a-8b3e-4ee3-8a58-b1dc0050dbd2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>8839006a-8b3e-4ee3-8a58-b1dc0050dbd2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </WritePermissionGroups> <Description>sample string 1</Description> <IsAdditionalFilter>true</IsAdditionalFilter> <ParentCategoryTypeIdentities xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security"> <d2p1:NamedObject> <d2p1:Identity>8839006a-8b3e-4ee3-8a58-b1dc0050dbd2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>8839006a-8b3e-4ee3-8a58-b1dc0050dbd2</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> </ParentCategoryTypeIdentities> </CategoryType>