Jump to

• Request
• Response
• Examples

Create or Update an Entity

post

/serviceapi/entityModel/uds/entities

Creates or updates an entity.

This endpoint can be used even if the associated entity type doesn't exist.

The entities created can be tagged with a set of keys and values using the tags attribute. It is also possible to specify a set of tagged associations with the given destination entities.

If the entity already exists it is updated with the given data. Existing tags and associations which are not specified in the updated payload will be removed.

Request

Supported Media Types

• application/json

Body ()

This model describes an entity managed by Oracle Management Cloud. An entity is defined by its name and type. It can have a different display name than the entity name. The display name is used in the GUI to display the entity. There can be associations to other entities and an entity can be tagged by a key/value pair.

Root Schema : UdsManageableEntity

Type: object

This model describes an entity managed by Oracle Management Cloud. An entity is defined by its name and type. It can have a different display name than the entity name. The display name is used in the GUI to display the entity. There can be associations to other entities and an entity can be tagged by a key/value pair.

Show Source

• associations(optional): array associations
  The associated entities
• entityDisplayName(optional): string
  The entity display name

  Example: My Entity Name
• entityName: string
  The entity name

  Example: my_entity_name
• entityType: string
  The entity type

  Example: my_entity_type
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  The properties assigned to the entity
• tags(optional): object tags
  Additional Properties Allowed: additionalProperties

  The tags assigned to the entity
• typeDisplayName(optional): string
  The entity type display name

  Example: My Entity Type

{
    "type":"object",
    "required":[
        "entityName",
        "entityType"
    ],
    "properties":{
        "associations":{
            "type":"array",
            "description":"The associated entities",
            "items":{
                "$ref":"#/definitions/UdsAssociation"
            }
        },
        "entityDisplayName":{
            "type":"string",
            "example":"My Entity Name",
            "description":"The entity display name"
        },
        "entityName":{
            "type":"string",
            "example":"my_entity_name",
            "description":"The entity name"
        },
        "entityType":{
            "type":"string",
            "example":"my_entity_type",
            "description":"The entity type"
        },
        "properties":{
            "type":"object",
            "description":"The properties assigned to the entity",
            "additionalProperties":{
                "type":"string"
            }
        },
        "tags":{
            "type":"object",
            "description":"The tags assigned to the entity",
            "additionalProperties":{
                "type":"string"
            }
        },
        "typeDisplayName":{
            "type":"string",
            "example":"My Entity Type",
            "description":"The entity type display name"
        }
    },
    "description":"<p>\n    This model describes an entity managed by Oracle Management Cloud.\n    An entity is defined by its name and type. It can have a different display\n    name than the entity name. The display name is used in the GUI to\n    display the entity. There can be associations to other entities and an\n    entity can be tagged by a key/value pair.\n</p>"
}

Nested Schema : associations

Type: array

The associated entities

Show Source

• Array of: object UdsAssociation

  This model describes an association between two or more entities. An entity can have associations to other entities which are called associates.

{
    "type":"array",
    "description":"The associated entities",
    "items":{
        "$ref":"#/definitions/UdsAssociation"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The properties assigned to the entity",
    "additionalProperties":{
        "type":"string"
    }
}

The properties assigned to the entity

Nested Schema : tags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The tags assigned to the entity",
    "additionalProperties":{
        "type":"string"
    }
}

The tags assigned to the entity

Nested Schema : UdsAssociation

Type: object

This model describes an association between two or more entities. An entity can have associations to other entities which are called associates.

Show Source

• entityName: string
  The entity name of the associate

  Example: MyLinuxHost
• entityType: string
  The entity type of the associate

  Example: omc_host_linux
• tags: object tags
  Additional Properties Allowed: additionalProperties

  The association tags

{
    "type":"object",
    "required":[
        "entityName",
        "entityType",
        "tags"
    ],
    "properties":{
        "entityName":{
            "type":"string",
            "example":"MyLinuxHost",
            "description":"The entity name of the associate"
        },
        "entityType":{
            "type":"string",
            "example":"omc_host_linux",
            "description":"The entity type of the associate"
        },
        "tags":{
            "type":"object",
            "description":"The association tags",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"<p>\n    This model describes an association between two or more entities. An entity\n    can have associations to other entities which are called associates.\n</p>"
}

Nested Schema : tags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"The association tags",
    "additionalProperties":{
        "type":"string"
    }
}

The association tags

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success - An existing entity has been updated

201 Response

Success - A new entity has been created

Back to Top

Examples

Create an entity by given name and type:

Payload

{
  "entityType":"HostLinux",
  "entityName":"myHostEntity"
}

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

Create or update an entity with given tags for location and organization:

Payload

{
  "entityType":"HostLinux",
  "entityName":"MyHostEntity",
  "tags":{
    "loc":"nyc",
    "org":"support"
  }
}

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

Create or update an Entity with given associations:

Payload

{
  "entityType":"HostLinux",
  "entityName":"MyHostEntity",
  "associations"[
    {
      "tags": { "runs_on":"app" }
      "entityType":"MyApplicationType",
      "entityName":"MyApplication"
    }
  ]
}

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

Back to Top