POST api/Policy/PolicyTags

Policy tags endpoint.

Request Information

URI Parameters

None.

Body Parameters

List of policies database Ids.

PolicyDataBaseIds
NameDescriptionTypeAdditional information
PolicyDataBaseId

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "policyDataBaseId": [
    "84e16e31-fbf8-41b7-b2e9-5a8b3d285208",
    "284eaa32-ca3e-4130-90c4-3d2117adc5f0"
  ]
}

application/xml, text/xml

Sample:
<PolicyDataBaseIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData">
  <PolicyDataBaseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>84e16e31-fbf8-41b7-b2e9-5a8b3d285208</d2p1:guid>
    <d2p1:guid>284eaa32-ca3e-4130-90c4-3d2117adc5f0</d2p1:guid>
  </PolicyDataBaseId>
</PolicyDataBaseIds>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of tags against given policies database Ids.

PolicyTags
NameDescriptionTypeAdditional information
DatabaseId

globally unique identifier

None.

Name

string

None.

Description

string

None.

CategoryName

string

None.

DateApplied

date

None.

Color

string

None.

PolicyDatabaseId

globally unique identifier

None.

TagDatabaseId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "databaseId": "66ba8033-2538-4cf4-8f88-7952a04d5e4e",
  "name": "sample string 2",
  "description": "sample string 3",
  "categoryName": "sample string 4",
  "dateApplied": "2023-05-31T06:26:10.3113805-05:00",
  "color": "sample string 6",
  "policyDatabaseId": "05d80a3c-4c36-442b-9483-a9e49a5c4d02",
  "tagDatabaseId": "9e0fdbcc-a5e2-433f-a3f2-505d3c975214"
}

application/xml, text/xml

Sample:
<PolicyTags xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <CategoryName>sample string 4</CategoryName>
  <Color>sample string 6</Color>
  <DatabaseId>66ba8033-2538-4cf4-8f88-7952a04d5e4e</DatabaseId>
  <DateApplied>2023-05-31T06:26:10.3113805-05:00</DateApplied>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <PolicyDatabaseId>05d80a3c-4c36-442b-9483-a9e49a5c4d02</PolicyDatabaseId>
  <TagDatabaseId>9e0fdbcc-a5e2-433f-a3f2-505d3c975214</TagDatabaseId>
</PolicyTags>