Jump to

• Request
• Response

Get the create samples for the target type

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targetTypes/{type}/targetCreateSamples

This api returns the list of create samples for the given target type. To get the correct samples the user can specify the agent which will host the new target or the target id or name of an existing target of that type. Without specifying the agent or target the samples returned will be the ones for the latest known type metaver. The samples will contain all data needed to create a target but the values will have to be edited by the user.

Request

Path Parameters

• type(required): string
  the target type

Query Parameters

• agentId: string
  the id of the agent.

  Example:

  123456789

• agentName: string
  the name of the agent.

  Example:

  myagent

• full: boolean
  indicates if all instance properties shall be in the sample.

  Example:

  true

• targetId: string
  the id of the target.

  Example:

  123456789

• targetName: string
  the name of the target.

  Example:

  MyTarget

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Response

Body ()

Root Schema : schema

Type: array

the create templates

Show Source

• Array of: object TargetCreateSample
  This is a target reference.

{
    "type":"array",
    "description":"the create templates",
    "items":{
        "$ref":"#/components/schemas/TargetCreateSample"
    }
}

Nested Schema : TargetCreateSample

Type: object

This is a target reference.

Show Source

• payload(required): object TargetCreatePayload
  Payload needed for a target creation request.
• sampleDescription(required): string
  the description of the template

  Example: System generated generic target create template
• sampleName(required): string
  the name of the template

  Example: generic
• typeName(required): string
  the target type of the template

  Example: oracle_database
• typeVersion(required): string
  the type version of the payload

  Example: 13.5.1

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a target reference.",
    "type":"object",
    "required":[
        "typeName",
        "sampleName",
        "sampleDescription",
        "typeVersion",
        "payload"
    ],
    "properties":{
        "typeName":{
            "type":"string",
            "description":"the target type of the template",
            "example":"oracle_database"
        },
        "sampleName":{
            "type":"string",
            "description":"the name of the template",
            "example":"generic"
        },
        "sampleDescription":{
            "type":"string",
            "description":"the description of the template",
            "example":"System generated generic target create template"
        },
        "typeVersion":{
            "type":"string",
            "description":"the type version of the payload",
            "example":"13.5.1"
        },
        "payload":{
            "$ref":"#/components/schemas/TargetCreatePayload"
        }
    }
}

Nested Schema : TargetCreatePayload

Type: object

Payload needed for a target creation request.

Show Source

• accessPoint: object NameTypePair
  A pair of name and type.
• credentials: object credentials
  Additional Properties Allowed: additionalProperties

  the target credentials
• displayName: string
  the target display name
• hostName: string
  the host of the target
• instances: array instances
  the instances that the target shall be connected to (only applicable for RAC targets)
• monitoringCredentials: array monitoringCredentials
  the targets monitoring credentials
• name(required): string
  the target name
• properties: array properties
  the target properties. This can be global target properties, type specific target properties or user defined properties
• timezoneRegion: string
  the timezone of the target
• typeName: string
  the target type name

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload needed for a target creation request.",
    "type":"object",
    "required":[
        "name",
        "type"
    ],
    "properties":{
        "name":{
            "description":"the target name",
            "type":"string"
        },
        "typeName":{
            "description":"the target type name",
            "type":"string"
        },
        "displayName":{
            "description":"the target display name",
            "type":"string"
        },
        "hostName":{
            "description":"the host of the target",
            "type":"string"
        },
        "timezoneRegion":{
            "description":"the timezone of the target",
            "type":"string"
        },
        "properties":{
            "description":"the target properties. This can be global target properties, type specific target properties or user defined properties",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TargetPropertySummary"
            }
        },
        "credentials":{
            "description":"the target credentials",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "instances":{
            "description":"the instances that the target shall be connected to (only applicable for RAC targets)",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NameTypePair"
            }
        },
        "monitoringCredentials":{
            "description":"the targets monitoring credentials",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MonitoringCredential"
            }
        },
        "accessPoint":{
            "$ref":"#/components/schemas/NameTypePair"
        }
    }
}

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 : credentials

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"the target credentials",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

the target credentials

Nested Schema : instances

Type: array

the instances that the target shall be connected to (only applicable for RAC targets)

Show Source

• Array of: object NameTypePair
  A pair of name and type.

{
    "description":"the instances that the target shall be connected to (only applicable for RAC targets)",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameTypePair"
    }
}

Nested Schema : monitoringCredentials

Type: array

the targets monitoring credentials

Show Source

• Array of: object MonitoringCredential
  A monitoring credential is used to describe which credential set and attributes is used to access a target.

{
    "description":"the targets monitoring credentials",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MonitoringCredential"
    }
}

Nested Schema : properties

Type: array

the target properties. This can be global target properties, type specific target properties or user defined properties

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. This can be global target properties, type specific target properties or user defined properties",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TargetPropertySummary"
    }
}

Nested Schema : MonitoringCredential

Type: object

A monitoring credential is used to describe which credential set and attributes is used to access a target.

Show Source

• attributes: array attributes
  Additional Properties Allowed: additionalProperties

  the attributes of the credential
• authenticatingTargetType: string
  the authenticating target type of the set
• credentialType: string
  the credential type
• monitoringCredentialSetName: string
  the name of the credential set

{
    "x-em-sdk-level":"emSDK",
    "description":"A monitoring credential is used to describe which credential set and attributes is used to access a target.",
    "type":"object",
    "properties":{
        "monitoringCredentialSetName":{
            "description":"the name of the credential set",
            "type":"string"
        },
        "authenticatingTargetType":{
            "description":"the authenticating target type of the set",
            "type":"string"
        },
        "credentialType":{
            "description":"the credential type",
            "type":"string"
        },
        "attributes":{
            "description":"the attributes of the credential",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NameValuePair"
            },
            "example":[
                {
                    "name":"UserName",
                    "value":"MyUserName"
                },
                {
                    "name":"Password",
                    "value":"MyPassword"
                }
            ],
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Additional Properties Allowed

Show Source

• string

{
    "description":"the attributes of the credential",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValuePair"
    },
    "example":[
        {
            "name":"UserName",
            "value":"MyUserName"
        },
        {
            "name":"Password",
            "value":"MyPassword"
        }
    ],
    "additionalProperties":{
        "type":"string"
    }
}

the attributes of the credential

Show Source

• Array of: object NameValuePair
  A pair of name and value.

{
    "description":"the attributes of the credential",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValuePair"
    },
    "example":[
        {
            "name":"UserName",
            "value":"MyUserName"
        },
        {
            "name":"Password",
            "value":"MyPassword"
        }
    ],
    "additionalProperties":{
        "type":"string"
    }
}

Example:

[
    {
        "name":"UserName",
        "value":"MyUserName"
    },
    {
        "name":"Password",
        "value":"MyPassword"
    }
]

Nested Schema : NameValuePair

Type: object

A pair of name and value.

Show Source

• name: string
  the name
• value: string
  the value

{
    "x-em-sdk-level":"emSDK",
    "description":"A pair of name and value.",
    "type":"object",
    "properties":{
        "name":{
            "description":"the name",
            "type":"string"
        },
        "value":{
            "description":"the value",
            "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"
        }
    }
}

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