Jump to

• Request
• Response

Get deployment procedures

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedures

Returns list of Deployment Procedures for a given filtering criteria.By default, it shows the 20 most recently created deployment procedures. In emcli, it is equivalent to 'get_procedures -procedure='

Request

Query Parameters

• include: string
  if include=procedureInput or include=XmlFormat, information about procedure input/procedure xml is included in the response
• limit: integer
  Minimum Value: 1

  Maximum Value: 2000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. The api will return no more than the number specified as limit, but might not return that exact number.

  Default Value: 20
• name: string
  Returns deployment procedure input using procedure name
• owner: string
  Returns deployment procedure input using owner name
• page: string
  System generated page token of a page.
• parentName: string
  Returns deployment procedures using parent procedure name
• sort: string
  Returns sorted deployment procedures.Allowed directions are DESC and ASC
• type: string
  Returns deployment procedures using procedure type

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of Procedures returned successfully

Body ()

Root Schema : DeploymentProcedureCollection

Type: object

This is the representation of list of Procedures.

Show Source

• items(required): array items
  The list of Procedures

{
    "description":"This is the representation of list of Procedures.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CountLinks"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of Procedures",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureSummary"
            }
        }
    }
}

Match All

Show Source

• object CountLinks
  This represents pagination properties like count and links.

{
    "description":"This is the representation of list of Procedures.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CountLinks"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of Procedures",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

The list of Procedures

Show Source

• Array of: object DeploymentProcedureSummary
  This is the representation of a Procedure.

{
    "type":"array",
    "description":"The list of Procedures",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureSummary"
    }
}

Nested Schema : CountLinks

Type: object

This represents pagination properties like count and links.

Show Source

• count: integer
  This represents total number of elements in a page.

  Example: 20
• links: object links
  Read Only: true

  The result set navigation links

{
    "description":"This represents pagination properties like count and links.",
    "properties":{
        "count":{
            "description":"This represents total number of elements in a page.",
            "type":"integer",
            "example":20
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"The result set navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : DeploymentProcedureSummary

Type: object

This is the representation of a Procedure.

Match All

Show Source

• object DeploymentProcedureDetails
  This is the representation of a Procedure.

{
    "description":"This is the representation of a Procedure.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureDetails"
        }
    ]
}

Nested Schema : DeploymentProcedureDetails

Type: object

This is the representation of a Procedure.

Show Source

• displayName: string
  Display Name of a Procedure

  Example: Copy of TEST_DP
• id: string
  Unique identifier for a Procedure

  Example: B0FBBE587FD201E2E0537013790A7D53
• links: object links
  Procedure related links
• name: string
  Name of a Procedure

  Example: DP_CC67765EF65F51A5E053E00F4B64D991
• owner: string
  Owner of a Procedure

  Example: SYSMAN
• parentName: string
  Parent procedure of a Procedure

  Example: TEST_DP
• procedureInput: object procedureInput
  input which given during submit procedure
• type: string
  Type of a Procedure

  Example: UserDefined
• version: string
  Version Number of a Procedure

  Example: Succeeded
• xmlFormat: string
  returns DP xml which can be reused to register.

{
    "description":"This is the representation of a Procedure.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a Procedure",
            "example":"B0FBBE587FD201E2E0537013790A7D53"
        },
        "name":{
            "type":"string",
            "description":"Name of a Procedure",
            "example":"DP_CC67765EF65F51A5E053E00F4B64D991"
        },
        "type":{
            "type":"string",
            "description":"Type of a Procedure",
            "example":"UserDefined"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of a Procedure",
            "example":"Copy of TEST_DP"
        },
        "version":{
            "type":"string",
            "description":"Version Number of a Procedure",
            "example":"Succeeded"
        },
        "owner":{
            "type":"string",
            "description":"Owner of a Procedure",
            "example":"SYSMAN"
        },
        "parentName":{
            "type":"string",
            "description":"Parent procedure of a Procedure",
            "example":"TEST_DP"
        },
        "procedureInput":{
            "type":"object",
            "description":"input which given during submit procedure",
            "allOf":[
                {
                    "$ref":"#/components/schemas/DescribeProcedureInput"
                }
            ]
        },
        "xmlFormat":{
            "type":"string",
            "description":"returns DP xml which can be reused to register."
        },
        "links":{
            "type":"object",
            "description":"Procedure related links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Procedure related links

Show Source

• self: object Link
  Represents a link(could be self, previous or next)

{
    "type":"object",
    "description":"Procedure related links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : procedureInput

Type: object

input which given during submit procedure

Match All

Show Source

• object DescribeProcedureInput
  This is the representation of an input given while submitting deployment procedure.

{
    "type":"object",
    "description":"input which given during submit procedure",
    "allOf":[
        {
            "$ref":"#/components/schemas/DescribeProcedureInput"
        }
    ]
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

Nested Schema : DescribeProcedureInput

Type: object

This is the representation of an input given while submitting deployment procedure.

Show Source

• links: object links
  Self link
• schedule: object Schedule
  Schedule details
• targets: array DeploymentProcedureTargetList
  Defining list of procedure targets
• variables: object DeploymentProcedureVariableCollection
  Collections of Procedure Variable

{
    "description":"This is the representation of an input given while submitting deployment procedure.",
    "type":"object",
    "properties":{
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetList"
        },
        "variables":{
            "$ref":"#/components/schemas/DeploymentProcedureVariableCollection"
        },
        "schedule":{
            "$ref":"#/components/schemas/Schedule"
        },
        "links":{
            "type":"object",
            "description":"Self link",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Self link

Show Source

• self: object Link
  Represents a link(could be self, previous or next)

{
    "type":"object",
    "description":"Self link",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : Schedule

Type: object

Schedule details

Show Source

• isTargetZone: boolean
  To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition
• recurring: string
  Frequency at which the operation must be executed repeatedly

  Example: frequency:weekly;days:2,
• scheduleType: string
  Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON.
• startGracePeriodInMinutes: integer
  Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.

  Example: 60
• timeToEnd: string (date-time)
  End time
• timeToStart: string (date-time)
  Start time

{
    "description":"Schedule details",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time",
            "format":"date-time"
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time",
            "format":"date-time"
        },
        "isTargetZone":{
            "type":"boolean",
            "description":"To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition"
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"frequency:weekly;days:2,"
        },
        "startGracePeriodInMinutes":{
            "type":"integer",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":60
        }
    }
}

Nested Schema : DeploymentProcedureTargetList

Type: array

Defining list of procedure targets

Show Source

• Array of: object items

{
    "description":"Defining list of procedure targets",
    "type":"array",
    "items":{
        "properties":{
            "name":{
                "type":"string",
                "description":"name of target type",
                "example":"host"
            },
            "targets":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
            }
        }
    }
}

Nested Schema : DeploymentProcedureVariableCollection

Type: object

Collections of Procedure Variable

Show Source

• items: array items
  The list of procedure variables

{
    "description":"Collections of Procedure Variable",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of procedure variables",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  name of target type

  Example: host
• targets: object DeploymentProcedureTargetCollection
  Collections of Procedure Target

{
    "properties":{
        "name":{
            "type":"string",
            "description":"name of target type",
            "example":"host"
        },
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
        }
    }
}

Nested Schema : DeploymentProcedureTargetCollection

Type: object

Collections of Procedure Target

Show Source

• items: array items
  The list of targets

{
    "description":"Collections of Procedure Target",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of targets",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

The list of targets

Show Source

• Array of: object DeploymentProcedureTargetSummary
  This is the representation of Procedure Target

{
    "type":"array",
    "description":"The list of targets",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
    }
}

Nested Schema : DeploymentProcedureTargetSummary

Type: object

This is the representation of Procedure Target

Match All

Show Source

• object DeploymentProcedureTargetDetails
  Defining Target for Deployment Procedure

{
    "description":"This is the representation of Procedure Target",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetDetails"
        }
    ]
}

Nested Schema : DeploymentProcedureTargetDetails

Type: object

Defining Target for Deployment Procedure

Show Source

• credentialReferences: array CredentialReference
  This is the representation of credential references.
• targetName: string
  Target Name

  Example: host1.oracle.com
• targetType: string
  Target Type

  Example: host

{
    "description":"Defining Target for Deployment Procedure",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target Name",
            "example":"host1.oracle.com"
        },
        "targetType":{
            "type":"string",
            "description":"Target Type",
            "example":"host"
        },
        "credentialReferences":{
            "$ref":"#/components/schemas/CredentialReference"
        }
    }
}

Nested Schema : CredentialReference

Type: array

This is the representation of credential references.

Show Source

• Array of: object items

{
    "description":"This is the representation of credential references.",
    "type":"array",
    "items":{
        "properties":{
            "usage":{
                "type":"string",
                "description":"Represents credential usage",
                "example":"defaultHostCred"
            },
            "credentialType":{
                "type":"string",
                "description":"Represents type of the credential",
                "example":"NAMED"
            },
            "owner":{
                "type":"string",
                "description":"Represents owner of the credential",
                "example":"SYSMAN"
            },
            "credentialName":{
                "type":"string",
                "description":"Represents credential name",
                "example":"EMGA"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• credentialName: string
  Represents credential name

  Example: EMGA
• credentialType: string
  Represents type of the credential

  Example: NAMED
• owner: string
  Represents owner of the credential

  Example: SYSMAN
• usage: string
  Represents credential usage

  Example: defaultHostCred

{
    "properties":{
        "usage":{
            "type":"string",
            "description":"Represents credential usage",
            "example":"defaultHostCred"
        },
        "credentialType":{
            "type":"string",
            "description":"Represents type of the credential",
            "example":"NAMED"
        },
        "owner":{
            "type":"string",
            "description":"Represents owner of the credential",
            "example":"SYSMAN"
        },
        "credentialName":{
            "type":"string",
            "description":"Represents credential name",
            "example":"EMGA"
        }
    }
}

Nested Schema : items

Type: array

The list of procedure variables

Show Source

• Array of: object DeploymentProcedureVariableSummary
  This is the representation of Procedure Variable

{
    "type":"array",
    "description":"The list of procedure variables",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
    }
}

Nested Schema : DeploymentProcedureVariableSummary

Type: object

This is the representation of Procedure Variable

Match All

Show Source

• object DeploymentProcedureVariableDetails
  Defining Variable for Deployment Procedure

{
    "description":"This is the representation of Procedure Variable",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableDetails"
        }
    ]
}

Nested Schema : DeploymentProcedureVariableDetails

Type: object

Defining Variable for Deployment Procedure

Show Source

• variableName: string
  Displays Deployment Procedure varibale name

  Example: userId
• variableValue: string
  Displays Deployment Procedure varibale value

  Example: 10001

{
    "description":"Defining Variable for Deployment Procedure",
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale name",
            "example":"userId"
        },
        "variableValue":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale value",
            "example":10001
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

The result set navigation links

Show Source

• next: object Link
  Represents a link(could be self, previous or next)
• previous: object Link
  Represents a link(could be self, previous or next)
• self: object Link
  Represents a link(could be self, previous or next)

{
    "type":"object",
    "readOnly":true,
    "description":"The result set navigation links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

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

Unauthorized. The user does not have permissions to perform the requested operation

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"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

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 Server Error. Exception in execution of REST API.

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

Service Unavailable. The server is unable to process 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"
        }
    }
}

Back to Top