Jump to

• Request
• Response

Update or create properties of a target

post

https://EM_HOST:8080/em/api/targets/{targetId}/actions/bulkUpdateProperties

Update the properties of the target identified by the given id

Request

Path Parameters

• targetId(required): string
  the target id

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload to create or update target properties

Show Source

• propagateToMembers: boolean
  indicates if the property changes shall get propagated to member targets.

  Example: false
• properties: array properties
  the target properties to set

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to create or update target properties",
    "type":"object",
    "properties":{
        "propagateToMembers":{
            "description":"indicates if the property changes shall get propagated to member targets.",
            "type":"boolean",
            "example":false
        },
        "properties":{
            "description":"the target properties to set",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TargetPropertySummary"
            },
            "example":[
                {
                    "id":"orcl_gtp_os",
                    "name":"Operating System",
                    "displayName":"Betriebssystem",
                    "value":"Linux"
                },
                {
                    "id":"orcl_gtp_platform",
                    "name":"Platform",
                    "displayName":"Plattform",
                    "value":"x86_64"
                }
            ]
        }
    }
}

Nested Schema : properties

Type: array

the target properties to set

Show Source

• Array of: object TargetPropertySummary
  A target property describes a property of a target by id, name, display name and the value

{
    "description":"the target properties to set",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TargetPropertySummary"
    },
    "example":[
        {
            "id":"orcl_gtp_os",
            "name":"Operating System",
            "displayName":"Betriebssystem",
            "value":"Linux"
        },
        {
            "id":"orcl_gtp_platform",
            "name":"Platform",
            "displayName":"Plattform",
            "value":"x86_64"
        }
    ]
}

Example:

[
    {
        "id":"orcl_gtp_os",
        "name":"Operating System",
        "displayName":"Betriebssystem",
        "value":"Linux"
    },
    {
        "id":"orcl_gtp_platform",
        "name":"Platform",
        "displayName":"Plattform",
        "value":"x86_64"
    }
]

Nested Schema : TargetPropertySummary

Type: object

A target property describes a property of a target by id, name, display name and the value

Show Source

• displayName: string
  the property name in the client locale. If the client locale is unknown or not supported this is the same as the name.
• id: string
  the property id. This is the internal name of the property
• name: string
  the English property name.
• value: string
  the property value.

{
    "x-em-sdk-level":"emSDK",
    "description":"A target property describes a property of a target by id, name, display name and the value",
    "type":"object",
    "properties":{
        "id":{
            "description":"the property id. This is the internal name of the property",
            "type":"string"
        },
        "name":{
            "description":"the English property name.",
            "type":"string"
        },
        "displayName":{
            "description":"the property name in the client locale. If the client locale is unknown or not supported this is the same as the name.",
            "type":"string"
        },
        "value":{
            "description":"the property value.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

400 Response

in the case of a processing error like unsupported property given etc.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

target not found or not authorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top