POST api/PBI_role/role

Request Information

URI Parameters

None.

Body Parameters

Name	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": "601a4190-9002-4bce-8f19-5aca42a69421",
  "customerName": "sample string 4",
  "id": "91f06766-7368-4b4a-a2f4-ba7eb800a2bd",
  "names": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "permissions": [
    {
      "id": "fd704783-645a-4917-bf3d-1938ec63fdf5",
      "active": true,
      "foreign_ID": "482d7ad9-b482-4b67-8d50-a0947c17a700",
      "foreign_Label": "sample string 3",
      "type": 1
    },
    {
      "id": "fd704783-645a-4917-bf3d-1938ec63fdf5",
      "active": true,
      "foreign_ID": "482d7ad9-b482-4b67-8d50-a0947c17a700",
      "foreign_Label": "sample string 3",
      "type": 1
    }
  ],
  "site_ID": "ab82509f-5d8f-4b90-8ae0-4dd120d42a08",
  "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>601a4190-9002-4bce-8f19-5aca42a69421</customer_ID>
  <id>91f06766-7368-4b4a-a2f4-ba7eb800a2bd</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>482d7ad9-b482-4b67-8d50-a0947c17a700</Foreign_ID>
      <Foreign_Label>sample string 3</Foreign_Label>
      <ID>fd704783-645a-4917-bf3d-1938ec63fdf5</ID>
      <type>SiteCustomer</type>
    </PBI_PermissionsViewModel>
    <PBI_PermissionsViewModel>
      <Active>true</Active>
      <Foreign_ID>482d7ad9-b482-4b67-8d50-a0947c17a700</Foreign_ID>
      <Foreign_Label>sample string 3</Foreign_Label>
      <ID>fd704783-645a-4917-bf3d-1938ec63fdf5</ID>
      <type>SiteCustomer</type>
    </PBI_PermissionsViewModel>
  </permissions>
  <siteName>sample string 8</siteName>
  <site_ID>ab82509f-5d8f-4b90-8ae0-4dd120d42a08</site_ID>
</PBI_RoleViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"a18f2bb6-394d-4b27-8040-7a4cec21b6c5"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">a18f2bb6-394d-4b27-8040-7a4cec21b6c5</guid>