Jump to

• Request
• Response
• Examples

Create a Group

post

/serviceapi/entityModel/uds/groups

Creates a tag-based group.

The call will fail if the group already exists.

For the tag criteria allowed, see Query Entities by Tag Criteria API.

Request

Supported Media Types

• application/json

Body ()

Describes a tag based group.

Root Schema : UdsGroup

Type: object

Describes a tag based group.

Show Source

• groupDisplayName(optional): string
  The group display name

  Example: My Group Name
• groupName: string
  The group name

  Example: my_group_name
• tagCriteria: string
  The tag criteria that defines the group

  Example: location=sfo AND organization=dev

{
    "type":"object",
    "required":[
        "groupName",
        "tagCriteria"
    ],
    "properties":{
        "groupDisplayName":{
            "type":"string",
            "example":"My Group Name",
            "description":"The group display name"
        },
        "groupName":{
            "type":"string",
            "example":"my_group_name",
            "description":"The group name"
        },
        "tagCriteria":{
            "type":"string",
            "example":"location=sfo AND organization=dev",
            "description":"The tag criteria that defines the group"
        }
    },
    "description":"<p>Describes a tag based group.</p>"
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

successful operation

Back to Top

Examples

Create a group with all entities belonging to marketing:

Payload:

{
  "groupName": "MyMarketingEntities",
  "groupDisplayName": "My Marketing Entities",
  "tagCriteria": "org=marketing"
}

curl -u ${OMC_USERNAME}:${PASSWORD} -X POST -H "Content-Type:application/json" -d "@example.json" "https://serverurl/serviceapi/entityModel/uds/groups"

Create a group with all entities belonging to sales in San Francisco and Development in Denver:

Payload:

{
    "groupName":"Sales Sfo",
    "tagCriteria":"(loc=sfo and org=sales) or (loc=den and org=dev)"
}

curl -u ${OMC_USERNAME}:${PASSWORD} -X POST -H "Content-Type:application/json" -d "@example.json" "https://serverurl/serviceapi/entityModel/uds/groups"

Back to Top