Jump to

• Request
• Response

Modify an existing target

patch

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

This api modifies an existing target identified by the given id. This is a parital update of the target. Only the given parts are updated.

Request

Path Parameters

• targetId(required): string
  the target id

Supported Media Types

• application/json+merge-patch

Request Body - application/json+merge-patch ()

Root Schema : schema

Type: object

The payload used to modify an existing target

Show Source

• accessPoint: accessPoint
  the access point for this update
• credentials: object credentials
  Additional Properties Allowed: additionalProperties

  the credentials to be updated
• displayName: string
  the display name of the target
• propagateToAgent: boolean
  indicates if property changes shall get promoted to the agent
• properties: array properties
  the properties to be updated

{
    "x-em-sdk-level":"emSDK",
    "description":"The payload used to modify an existing target",
    "type":"object",
    "properties":{
        "propagateToAgent":{
            "type":"boolean",
            "description":"indicates if property changes shall get promoted to the agent"
        },
        "displayName":{
            "type":"string",
            "description":"the display name of the target"
        },
        "properties":{
            "type":"array",
            "description":"the properties to be updated",
            "items":{
                "$ref":"#/components/schemas/TargetPropertySummary"
            }
        },
        "credentials":{
            "type":"object",
            "description":"the credentials to be updated",
            "additionalProperties":{
                "type":"string"
            }
        },
        "accessPoint":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/NameTypePair"
                }
            ],
            "description":"the access point for this update"
        }
    }
}

Nested Schema : accessPoint

the access point for this update

Match All

the access point for this update

Show Source

• object NameTypePair
  A pair of name and type.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/NameTypePair"
        }
    ],
    "description":"the access point for this update"
}

Nested Schema : credentials

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"the credentials to be updated",
    "additionalProperties":{
        "type":"string"
    }
}

the credentials to be updated

Nested Schema : properties

Type: array

the properties to be updated

Show Source

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

{
    "type":"array",
    "description":"the properties to be updated",
    "items":{
        "$ref":"#/components/schemas/TargetPropertySummary"
    }
}

Nested Schema : NameTypePair

Type: object

A pair of name and type.

Show Source

• name: string
  the name
• type: string
  the type

{
    "x-em-sdk-level":"emSDK",
    "description":"A pair of name and type.",
    "type":"object",
    "properties":{
        "name":{
            "description":"the name",
            "type":"string"
        },
        "type":{
            "description":"the type",
            "type":"string"
        }
    }
}

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

Successful Response

Body ()

Root Schema : schema

Type: object

Target details

Show Source

• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Type of the target

  Example: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

400 Response

indicates that there has been a processing error or an illegal argument, like an unsupported property.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Client is not authenticated.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404 Response

Resource not found or not authorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal error serving the request.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

Indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top