POST api/PBI_role/role
Request Information
URI Parameters
None.
Body Parameters
PBI_RoleViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| active | boolean |
None. |
|
| code | string |
Required |
|
| customer_ID | globally unique identifier |
None. |
|
| customerName | string |
None. |
|
| id | globally unique identifier |
None. |
|
| names | Dictionary of string [key] and string [value] |
Required |
|
| permissions | Collection of PBI_PermissionsViewModel |
Required |
|
| site_ID | globally unique identifier |
Required |
|
| siteName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"active": true,
"code": "sample string 2",
"customer_ID": "20be33ae-f2f2-4b3c-99a2-bd8dddc64439",
"customerName": "sample string 4",
"id": "f6e3972e-91e4-4800-8cef-f15c289ae014",
"names": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"permissions": [
{
"id": "d37302df-b5b3-462b-970d-a22d989143ef",
"active": true,
"foreign_ID": "912a6039-419b-4816-a44d-c9a81df577f5",
"foreign_Label": "sample string 3",
"type": 1
},
{
"id": "d37302df-b5b3-462b-970d-a22d989143ef",
"active": true,
"foreign_ID": "912a6039-419b-4816-a44d-c9a81df577f5",
"foreign_Label": "sample string 3",
"type": 1
}
],
"site_ID": "8d0c2c4a-e748-4549-9362-916aede01ca5",
"siteName": "sample string 8"
}
application/xml, text/xml
Sample:
<PBI_RoleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
<active>true</active>
<code>sample string 2</code>
<customerName>sample string 4</customerName>
<customer_ID>20be33ae-f2f2-4b3c-99a2-bd8dddc64439</customer_ID>
<id>f6e3972e-91e4-4800-8cef-f15c289ae014</id>
<names xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</names>
<permissions>
<PBI_PermissionsViewModel>
<Active>true</Active>
<Foreign_ID>912a6039-419b-4816-a44d-c9a81df577f5</Foreign_ID>
<Foreign_Label>sample string 3</Foreign_Label>
<ID>d37302df-b5b3-462b-970d-a22d989143ef</ID>
<type>SiteCustomer</type>
</PBI_PermissionsViewModel>
<PBI_PermissionsViewModel>
<Active>true</Active>
<Foreign_ID>912a6039-419b-4816-a44d-c9a81df577f5</Foreign_ID>
<Foreign_Label>sample string 3</Foreign_Label>
<ID>d37302df-b5b3-462b-970d-a22d989143ef</ID>
<type>SiteCustomer</type>
</PBI_PermissionsViewModel>
</permissions>
<siteName>sample string 8</siteName>
<site_ID>8d0c2c4a-e748-4549-9362-916aede01ca5</site_ID>
</PBI_RoleViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
globally unique identifierResponse Formats
application/json, text/json
Sample:
"5dab1530-a299-4d57-b2b5-6f3736580610"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5dab1530-a299-4d57-b2b5-6f3736580610</guid>