openapi: 3.0.1
info:
  title: AE REST API documentation
  description: "<div><p>The AE REST API provides an interface for 3<sup>rd</sup> party\t\
    applications to interact with the Automation Engine. It allows you to target\t\
    the AE from many programming languages, not only from Java. The AE REST API\t\
    will eventually expose the most important AE API features for 3<sup>rd</sup>\t\
    party developers.</p><p>Please see the AE Java API if you are looking for a more\
    \ comprehensive API.</p><p>The URI for each request has the form <strong><em>http[s]://{host}:{port}/ae/api/{version}</em></strong>.</p><ul><li><strong>host</strong>:\
    \ <em>required (string)</em>The host (IP address or hostname) on which the REST\
    \ is running</li><li><strong>port</strong>: <em>required (string)</em>Port of\
    \ the REST as configured in the REST section of <em>ucsrv.ini</em> (by default\
    \ the port is set to 8088)</li><li><strong>version</strong>: <em>required (string)</em>API\
    \ version, must be v1</li></ul><p>Responses which contain HTTP Status Codes <strong>4xx</strong>\
    \ through <strong>5xx</strong> signal client / server errors. Details are delivered\
    \ in the response body, formatted as <strong>application/json</strong>. Depending\
    \ on the number of errors, the top level element of responses will\teither be\
    \ an <strong>array of or a single object of type <em>OutError</em> or <em>OutValidationError</em></strong>.\t\
    Please see <em>POST /{client_id}/executions [400] and [401]</em> for an example.</p><p>A\
    \ <strong>health check</strong> is available under <em>GET /{client_id}/health</em>.\
    \ Be aware that solely the HTTP status code should\tbe used to determine the health\
    \ (<em>[200] signals healthy</em>, <em>[503] not healthy</em>). A response body\
    \ is optionally delivered,\tdepending on whether a PWP is currently present or\
    \ not. If no PWP is present, a body of type <em>OutError</em> is returned,\totherwise\
    \ it will be of type <em>OutHealthCheck</em>.</p><p><strong>Basic Authentication</strong>\
    \ is used to authenticate users in the system, so make sure the <em>Authorization</em>\
    \ header\tis present for each request. The user-pass section can be entered in\
    \ the following 3 formats <strong>USERNAME:PASSWORD</strong>,\t<strong>USERNAME/DEPARTMENT:PASSWORD</strong>\
    \ and <strong>CLIENT/USERNAME/DEPARTMENT:PASSWORD</strong>. The <strong>character\
    \ encoding scheme</strong>\tused to convert this section into an octet sequence\
    \ is expected to be <strong>ISO-8859-1</strong>.</p><p>The <strong>internal authorization\
    \ system</strong> is used to authorize inbound requests. Depending on the endpoint,\
    \ different privileges and authorizations are needed. If missing, a <em>[403]</em>\
    \ with details will be returned.</p><p>Some <strong>resources</strong> may be\
    \ <strong>disabled</strong> till a given precondition is met eg. a mandatory configuration\t\
    parameter is set. A call to a disabled resource yields a <em>[404] with a custom\
    \ error code and message.</em></p></div>"
  version: v1
paths:
  /{client_id}/executions:
    get:
      tags:
      - execution
      summary: "List executions, ordered descending by activation_time and run_id."
      operationId: listExecutions
      parameters:
      - name: max_results
        in: query
        description: Maximum number of executions for a page result set. If this parameter
          is omitted the default value 50 is applied.
        schema:
          minimum: 1
          type: integer
          format: int32
        example: 50
      - name: start_at_run_id
        in: query
        description: Requested page starts with execution with RunID > this parameter.
          If this parameter is omitted (no offset) the very first page is returned.
        schema:
          type: integer
          format: int32
        example: 1000030
      - name: run_id
        in: query
        description: RunID of the execution.
        schema:
          type: integer
          format: int32
        example: 1000030
      - name: name
        in: query
        description: Object name to query. Supports wildcards (*).
        schema:
          type: string
        example: SCRI.NEW.1
      - name: name_exclude
        in: query
        description: Exclude object name.
        schema:
          type: boolean
        example: true
      - name: alias
        in: query
        description: Object alias to query. Supports wildcards (*).
        schema:
          type: string
        example: SCRI.ALIAS.1
      - name: type
        in: query
        description: "Object types to query. Supports multiple, comma-separated values.\
          \ If omitted, all executable object types are used as default value."
        schema:
          type: array
          items:
            type: string
        example: SCRI
      - name: status
        in: query
        description: "Status to query. Supports multiple, comma-separated values."
        schema:
          type: array
          items:
            type: string
        example: 1800
      - name: agent
        in: query
        description: Agent name to query. Supports wildcards (*).
        schema:
          type: string
        example: WIN01
      - name: agent_exclude
        in: query
        description: Exclude agent name.
        schema:
          type: boolean
        example: false
      - name: platform
        in: query
        description: "Agent types to query. Supports multiple, comma-separated values."
        schema:
          type: array
          items:
            type: string
        example: WINDOWS
      - name: queue
        in: query
        description: "Queues to query. Supports multiple, comma-separated values."
        schema:
          type: array
          items:
            type: string
        example: CLIENT_QUEUE
      - name: include_deactivated
        in: query
        description: Include deactivated executions into query.
        schema:
          type: boolean
        example: false
      - name: time_frame_option
        in: query
        description: "Timeframe option to be used for the query. If omitted, the default\
          \ value of 'all' is applied."
        content:
          application/json:
            schema:
              type: string
              enum:
              - activation
              - start
              - end
              - all
      - name: time_frame_from
        in: query
        description: Timeframe lower bound to be used for the query.
        schema:
          pattern: "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])T(?:[01]\\\
            d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$"
          type: string
        example: 2015-04-15T06:37:59Z
      - name: time_frame_to
        in: query
        description: Timeframe upper bound to be used for the query.
        schema:
          pattern: "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])T(?:[01]\\\
            d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$"
          type: string
        example: 2015-04-15T06:37:59Z
      - name: user
        in: query
        description: Username to query. Supports wildcards (*).
        schema:
          type: string
        example: TEST/DEP
      - name: user_exclude
        in: query
        description: Exclude username.
        schema:
          type: boolean
        example: false
      - name: archive_key1
        in: query
        description: Archive key1 to query. Supports wildcards (*).
        schema:
          type: string
        example: key1
      - name: archive_key1_exclude
        in: query
        description: Exclude archive key1.
        schema:
          type: boolean
        example: false
      - name: archive_key2
        in: query
        description: Archive key2 to query. Supports wildcards (*).
        schema:
          type: string
        example: key2
      - name: archive_key2_exclude
        in: query
        description: Exclude archive key2.
        schema:
          type: boolean
        example: false
      - name: commented_only
        in: query
        description: Query only commented tasks.
        schema:
          type: boolean
        example: false
      - name: modified_only
        in: query
        description: Query only modified workflows.
        schema:
          type: boolean
        example: false
      - name: remote_status_number
        in: query
        description: Remote status text to query.
        schema:
          type: integer
          format: int32
        example: 1200
      - name: reference_run_id
        in: query
        description: "RunID of the original execution, zero if this was not a restart."
        schema:
          type: integer
          format: int32
        example: 1000031
      - name: remote_status_text
        in: query
        description: Remote status number to query.
        schema:
          type: string
        example: Executed
      - name: zdu_version
        in: query
        description: Query ZDU Version.
        content:
          application/json:
            schema:
              pattern: "([BT])"
              type: string
              enum:
              - B
              - T
      - name: sync_usage
        in: query
        description: "Sync objects to query. Supports multiple, comma-separated values."
        schema:
          type: array
          items:
            type: string
        example: SYNC1
      - name: fields
        in: query
        description: Parameter to include various additional information about an
          execution.<br><strong>restarts</strong> - Includes the number of restarts<br><strong>predecessors</strong>
          - Includes a list of the predecessors of a workflow task<br><strong>recurring</strong>
          - Includes details of a C_PERIOD task
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                enum:
                - restarts
                - predecessors
                - recurring
              enum:
              - restarts
              - predecessors
              - recurring
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutExecutionList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - execution
      summary: Execute an object with or without input parameters (promptsets variables).
      description: 'Examples can be found in dropdown component bellow:'
      operationId: executeObject
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InExecutionBody'
            examples:
              EXAMPLE ONCE RELEASE:
                value: null
                $ref: '#/components/examples/example-once-releaseIn'
              EXAMPLE ONCE TIME:
                value: null
                $ref: '#/components/examples/example-once-timeIn'
              EXAMPLE RECURRING CALENDAR INTERVAL:
                value: null
                $ref: '#/components/examples/example-recurring-calendar-intervalIn'
              EXAMPLE RECURRING GAP:
                value: null
                $ref: '#/components/examples/example-recurring-gapIn'
              EXAMPLE RECURRING WEEKLY:
                value: null
                $ref: '#/components/examples/example-recurring-weeklyIn'
              EXAMPLE WITH JSON INPUT:
                value: null
                $ref: '#/components/examples/example-with-json-inputIn'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRunId'
        "400":
          description: "Bad request - request data is invalid<br><br><span><b>45113</b>:\
            \ Given string is not a valid object name</span><br><span><b>45114</b>:\
            \ Given string is not a valid execution option</span><br><span><b>45115</b>:\
            \ Object to be executed is not an executable one</span>"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OutValidationError'
        "401":
          description: Unauthorized access - login data not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutError'
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/executions/{run_id}:
    get:
      tags:
      - execution
      summary: Get details of a given execution.
      operationId: getExecution
      parameters:
      - name: fields
        in: query
        description: Parameter to include various additional information about an
          execution.<br><strong>comments</strong> - Includes a list of all comments
          that have been added to the execution<br><strong>variables</strong> - Includes
          a list of all object variables defined at the execution's scope<br><strong>reports</strong>
          - Includes a list of all report types of the execution<br><strong>restarts</strong>
          - Includes the number of restarts<br><strong>predecessors</strong> - Includes
          a list of the predecessors of a workflow task<br><strong>recurring</strong>
          - Includes details of a C_PERIOD task
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                enum:
                - comments
                - variables
                - reports
                - restarts
                - predecessors
                - recurring
              enum:
              - comments
              - variables
              - reports
              - restarts
              - predecessors
              - recurring
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutExecution'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/executions/{run_id}/children:
    get:
      tags:
      - execution
      summary: "Gets all immediate execution children, ordered descending by activation_time\
        \ and run_id."
      operationId: getChildrenOfExecution
      parameters:
      - name: max_results
        in: query
        description: Maximum number of executions for a page result set. If this parameter
          is omitted the default value 50 is applied.
        schema:
          minimum: 1
          type: integer
          format: int32
        example: 50
      - name: start_at_run_id
        in: query
        description: Requested page starts with execution with RunID > this parameter.
          If this parameter is omitted (no offset) the very first page is returned.
        schema:
          type: integer
          format: int32
        example: 1000030
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutExecutionList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/executions/{run_id}/comments:
    get:
      tags:
      - execution
      - execution comment
      summary: List all comments for a given execution.
      operationId: list
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OutComment'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - execution comment
      - execution
      summary: Appends a comment to a given execution.
      operationId: create
      parameters: []
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InAddCommentBody'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutComment'
        "400":
          description: "Bad request - request data is invalid<br><br><span><b>45149</b>:\
            \ Client '...' is not allowed to perform this action.</span><br><span><b>45150</b>:\
            \ Property '...' may not be null.</span><br><span><b>45151</b>: Property\
            \ '...' contains an invalid value. '...'.</span><br>"
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/executions/{run_id}/ert:
    get:
      tags:
      - execution
      summary: Get ERT estimations for the given workflow.
      operationId: computeErtEstimations
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutErtEstimations'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/executions/{run_id}/reports:
    get:
      tags:
      - execution
      - execution report
      summary: Get Report list for a given execution.
      operationId: listReports
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OutReport'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/executions/{run_id}/reports/{report_type}:
    get:
      tags:
      - execution
      - execution report
      summary: Get Report content pages.
      description: Reports which are stored in the database can be returned. For External
        Reports this endpoint returns "404 Not Found".
      operationId: listReportContent
      parameters:
      - name: report_type
        in: path
        description: Type of a execution report
        required: true
        schema:
          type: string
      - name: max_results
        in: query
        description: Maximum number of report pages. If this parameter is omitted
          the default value 1 is applied.
        example: 5
        content:
          '*/*':
            schema:
              type: integer
              format: int32
              default: 1
      - name: start_at
        in: query
        description: Response lists report pages with numbers > this parameter.
        example: 3
        content:
          '*/*':
            schema:
              type: integer
              format: int32
              default: 1
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OutReportContent'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/executions/{run_id}/status:
    post:
      tags:
      - execution
      summary: Changes the status of an execution.
      description: "Requests for sample use-cases: <br><ul>\t<li><a href=\"examples/executions/status/example-cancel-simple.json\"\
        >Use Case 1:</a> Cancel a job including its children</li>\t<li><a href=\"\
        examples/executions/status/example-restart-simple.json\">Use Case 2:</a> Minimal\
        \ restart</li>\t<li><a href=\"examples/executions/status/example-restart-params.json\"\
        >Use Case 3:</a> Restart where parameters are passed</li></ul>"
      operationId: changeExecutionStatus
      parameters: []
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InChangeExecutionStatusBody'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutChangeExecutionStatus'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/executions/{run_id}/variables:
    get:
      tags:
      - execution
      - execution variable
      summary: List all variables for a given execution.
      operationId: listVariables
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamedResponse'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: run_id
      in: path
      description: RunID of the execution.
      required: true
      schema:
        type: integer
        format: int32
  /{client_id}/folderobjects:
    post:
      tags:
      - folder objects
      summary: Import objects to a target folder.
      description: Avoid importing the same objects at the same time because it can
        lead to interruption of at least one import proccess. Nevertheless if an import
        process ends ok it means it has been completes successfully.
      operationId: importFolderObjects
      parameters:
      - name: overwrite_existing_objects
        in: query
        description: Determines whether existing objects should get overwritten by
          the import
        example: true
        content:
          application/json:
            schema:
              type: boolean
              default: false
          application/octet-stream:
            schema:
              type: boolean
              default: false
      - name: folder_path
        in: query
        description: "Path of a folder where the objects should be imported.\nIf target\
          \ folder is empty the root folder is used as target folder.\nIf the target\
          \ folder does not exist, it will be created."
        example: FOLDER/SUBFOLDER
        content:
          application/json:
            schema:
              type: string
              default: ""
          application/octet-stream:
            schema:
              type: string
              default: ""
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InFolderObjects'
          application/octet-stream:
            schema:
              $ref: '#/components/schemas/InFolderObjects'
        required: true
      responses:
        default:
          description: default response
          content:
            '*/*': {}
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/folderobjects/{folder_path}:
    get:
      tags:
      - folder objects
      summary: Export all objects from a folder recursively.
      description: Keep in mind that big folder structures can create heavy load and
        cause performance decrease
      operationId: exportFolderObjects
      parameters:
      - name: folder_path
        in: path
        description: Path to the automation engine target folder that should be exported.
        required: true
        schema:
          type: string
        example: FOLDER/SUBFOLDER
      responses:
        "200":
          description: successful operation
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/OutFolderObjects'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/forecasts:
    get:
      tags:
      - forecast
      summary: "List all forecasts, ordered descending by start_time."
      operationId: listForecasts
      parameters:
      - name: fc_title
        in: query
        description: Forecast title to query. Supports wildcards (*).
        schema:
          type: string
        example: JOBP.NEW.FORECAST
      - name: fc_start_time
        in: query
        description: Minimum start time to query.
        schema:
          type: string
        example: 2018-02-18T10:00:00Z
      - name: fc_end_time
        in: query
        description: Maximum end time to query.
        schema:
          type: string
        example: 2018-02-19T10:00:00Z
      - name: fc_type
        in: query
        description: Forecast type to query. Omit to get all types.
        example: FCST
        content:
          '*/*':
            schema:
              type: string
              enum:
              - FCST
              - AFCST
      - name: name
        in: query
        description: Object name to query. Supports wildcards (*).
        schema:
          type: string
        example: SCRI.NEW.1
      - name: type
        in: query
        description: "Object types to query. Supports multiple, comma-separated values.\
          \ If omitted, all executable object types are used as default value."
        schema:
          type: array
          items:
            type: string
        example: SCRI
      - name: estimated_start_from
        in: query
        description: Logical start date lower bound to be used for the query.
        schema:
          type: string
        example: 2018-02-18T10:00:00Z
      - name: estimated_start_to
        in: query
        description: Logical start date upper bound to be used for the query.
        schema:
          type: string
        example: 2018-02-19T10:00:00Z
      - name: agent_destination
        in: query
        description: Agent name to query. Supports wildcards (*).
        schema:
          type: string
        example: WIN01
      - name: agent_source
        in: query
        description: Source agent name to query. Supports wildcards (*).
        schema:
          type: string
        example: WIN01
      - name: platform_destination
        in: query
        description: "Agent platform to query. Supports multiple, comma-separated\
          \ values."
        schema:
          type: array
          items:
            type: string
        example: WINDOWS
      - name: fields
        in: query
        description: Parameter to include various additional information about a forecast.<br><strong>entries</strong>
          - Includes a list of all entries within a forecast
        content:
          '*/*':
            schema:
              type: array
              items:
                type: string
                enum:
                - entries
              enum:
              - entries
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutForecastList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - forecast
      summary: Create a forecast.
      operationId: createForecast
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InForecastBody'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutForecastId'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    delete:
      tags:
      - forecast
      summary: Delete forecasts using ids.
      operationId: deleteForecast
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InForecastDeleteBody'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutIdList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/forecasts/agents:
    get:
      tags:
      - forecast
      summary: List forecast agents and gaps.
      operationId: listForecastAgents
      parameters:
      - name: name
        in: query
        description: Agent name to query. Supports wildcards (*).
        schema:
          type: string
        example: WIN01
      - name: type
        in: query
        description: "Agent types to query. Supports multiple, comma-separated values."
        schema:
          type: string
        example: WINDOWS
      - name: version
        in: query
        description: Agent version to query. Supports wildcards (*).
        schema:
          type: string
        example: 12.3.0+low.build.1100
      - name: from
        in: query
        description: Timeframe lower bound to be used for the query.
        required: true
        schema:
          type: string
        example: 2015-04-15T06:37:59Z
      - name: to
        in: query
        description: Timeframe upper bound to be used for the query.
        required: true
        schema:
          type: string
        example: 2015-04-15T06:37:59Z
      - name: execution_name
        in: query
        description: Timeframe upper bound to be used for the query.
        schema:
          type: string
        example: 2015-04-15T06:37:59Z
      - name: min_duration
        in: query
        description: Minimal duration of the gap.
        schema:
          pattern: "([-+]?)P(?:([-+]?[0-9]+)D)?(T(?:([-+]?[0-9]+)H)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)(?:[.,]([0-9]{0,9}))?S)?)?"
          type: string
        example: PT9H11M34S
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutForecastAgentList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/forecasts/{forecast_id}:
    get:
      tags:
      - forecast
      summary: Get details of a given forecast.
      operationId: getForecast
      parameters:
      - name: forecast_id
        in: path
        description: ID of the forecast.
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: Object name to query. Supports wildcards (*).
        schema:
          type: string
        example: SCRI.NEW.1
      - name: type
        in: query
        description: "Object types to query. Supports multiple, comma-separated values.\
          \ If omitted, all executable object types are used as default value."
        schema:
          type: array
          items:
            type: string
        example: SCRI
      - name: estimated_start_from
        in: query
        description: Logical start date lower bound to be used for the query.
        schema:
          type: string
        example: 2018-02-18T10:00:00Z
      - name: estimated_start_to
        in: query
        description: Logical start date upper bound to be used for the query.
        schema:
          type: string
        example: 2018-02-19T10:00:00Z
      - name: agent_destination
        in: query
        description: Agent name to query. Supports wildcards (*).
        schema:
          type: string
        example: WIN01
      - name: agent_source
        in: query
        description: Source agent name to query. Supports wildcards (*).
        schema:
          type: string
        example: WIN01
      - name: platform_destination
        in: query
        description: "Agent platform to query. Supports multiple, comma-separated\
          \ values."
        schema:
          type: array
          items:
            type: string
        example: WINDOWS
      - name: fields
        in: query
        description: Parameter to include various additional information about a forecast.<br><strong>entries</strong>
          - Includes a list of all entries within a forecast
        content:
          '*/*':
            schema:
              type: array
              items:
                type: string
                enum:
                - entries
              enum:
              - entries
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutForecast'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - forecast
      summary: Changes the title of a forecast item.
      operationId: modifyForecast
      parameters:
      - name: forecast_id
        in: path
        description: ID of the forecast.
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InModifyForecastBody'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutForecast'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/objects:
    post:
      tags:
      - object
      summary: Can be used to import single objects.
      operationId: post
      parameters:
      - name: overwrite_existing_objects
        in: query
        description: Determines whether existing objects should get overwritten by
          the import
        example: true
        content:
          application/json:
            schema:
              type: boolean
              default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InImportObjectBody'
        required: true
      responses:
        "200":
          description: Successful import
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/objects/{object_name}:
    get:
      tags:
      - object
      summary: Can be used to export single objects by name
      operationId: get
      parameters:
      - name: fields
        in: query
        description: Optional list of additional fields.<br><strong>modification_details</strong>
          - Includes modification/creation date and user name.<br>
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
                enum:
                - modification_details
              enum:
              - modification_details
      - name: filter
        in: query
        description: Optional list of fields to reduce the response and improve performance.
          general_attributes are always returned. Other fields on the same level can
          be specified as filter.
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              example: job_attributes
              items:
                type: string
                example: job_attributes
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutObject'
              examples:
                FILE TRANSFER:
                  value: null
                  $ref: '#/components/examples/file_transferOut'
                SIMPLE SCRIPT:
                  value: null
                  $ref: '#/components/examples/simple_scriptOut'
                STANDARD WORKFLOW:
                  value: null
                  $ref: '#/components/examples/standard_workflowOut'
                STATIC VARIABLE:
                  value: null
                  $ref: '#/components/examples/static_variableOut'
                UNIX JOB:
                  value: null
                  $ref: '#/components/examples/unix_jobOut'
                WINDOWS JOB:
                  value: null
                  $ref: '#/components/examples/windows_jobOut'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/objects/{object_name}/inputs:
    get:
      tags:
      - object
      summary: List all inputs for a given object.
      operationId: listObjectInputs
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamedResponse'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/objects/{object_name}/timezone:
    get:
      tags:
      - object
      summary: "Returns the time zone used by an object definition or defaults if\
        \ the object or time zone does not exist.If the queried object is a time zone\
        \ already, it will be directly evaluated."
      operationId: getTimezoneInfo
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutTimeZoneInfo'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/objects/{object_name}/usage:
    get:
      tags:
      - object
      summary: "Returns a list of objects with a reference name, a boolean to show\
        \ if the actual result has hidden objects due to acl conflicts, for the given\
        \ objectname"
      operationId: usage
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutObjectUsage'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/objects/{object_name}/usage/calendarevent/{event_name}:
    get:
      tags:
      - object
      summary: "Returns a list of objects with a reference name, a boolean to show\
        \ if the actual result has hidden objects due to acl conflicts, for the given\
        \ objectname"
      operationId: usageForCalendarEvents
      parameters:
      - name: event_name
        in: path
        description: Name of the Calendar Event.
        required: true
        schema:
          type: string
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutObjectUsage'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /ping:
    get:
      tags:
      - ping
      summary: Can be used to determine if the JCP process is currently running.
      operationId: ping
      responses:
        "200":
          description: Ping successful.
        "500":
          description: Internal error occurred.
  /{client_id}/productusage:
    get:
      tags:
      - product usage
      summary: Retrieve product usage data as json depending on the start and end
        time
      description: Only works for client 0.
      operationId: productUsage
      parameters:
      - name: start_date
        in: query
        description: The start date for the product usage report. Must be used together
          with 'end_date'.
        required: true
        schema:
          pattern: \d+(.\d+)?
          type: string
        example: 1634981659000
      - name: end_date
        in: query
        description: The end date for the product usage report. Must be used together
          with 'start_date'.
        required: true
        schema:
          pattern: \d+(.\d+)?
          type: string
        example: 1640259266540
      - name: skip
        in: query
        description: Number of records to skip for pagination
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
        example: 10
      - name: limit
        in: query
        description: Maximum number of records to return
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
        example: 50
      responses:
        "200":
          description: successful operation
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories:
    get:
      tags:
      - repositories
      summary: Retrieves repository information for the given client.
      operationId: getRepository
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepo'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - repositories
      summary: Initializes the repository for the specified client.
      operationId: createRepository
      parameters: []
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InRepositoryInit'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryInit'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/branches:
    get:
      tags:
      - repositories
      - repositories branches
      summary: Retrieves a list of branches.
      operationId: listBranches
      parameters:
      - name: max_results
        in: query
        description: Maximum number of executions for a page result set. If this parameter
          is omitted the default value 50 is applied.
        schema:
          minimum: 1
          type: integer
          format: int32
        example: 50
      - name: start_at
        in: query
        description: From which branch list entry paging should start.
        schema:
          minimum: 0
          type: integer
          format: int32
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryHistory'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - repositories
      - repositories branches
      summary: Create a new branch.
      operationId: createBranch
      parameters: []
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InCreateBranchParameters'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryBranch'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/branches/{branch_name}/diff:
    get:
      tags:
      - repositories
      - repositories branches
      summary: Get content of two files to see their differences.
      operationId: branchDiff
      parameters:
      - name: branch_name
        in: path
        description: Branch name where our file is located.
        required: true
        schema:
          type: string
        example: master
      - name: branch_name_theirs
        in: query
        description: Branch name where their file is located.
        required: true
        schema:
          type: string
        example: dev
      - name: object_path_ours
        in: query
        description: Path of the object on our branch which should be compared.
        required: true
        schema:
          type: string
        example: I.AM.CONFLICTING.SCRI
      - name: object_path_theirs
        in: query
        description: Path of the object on their branch which should be compared.
        required: true
        schema:
          type: string
        example: I.AM.CONFLICTING.SCRI
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryDiff'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/branches/{branch_name}/log:
    get:
      tags:
      - repositories
      - repositories branches
      summary: Retrieves the history of the repository for max_results entries.
      operationId: branchLog
      parameters:
      - name: branch_name
        in: path
        description: Name of the branch.
        required: true
        schema:
          type: string
      - name: max_results
        in: query
        description: Maximum number of executions for a page result set. If this parameter
          is omitted the default value 50 is applied.
        schema:
          minimum: 1
          type: integer
          format: int32
        example: 50
      - name: start_at
        in: query
        description: From which history entry paging should be started.
        schema:
          minimum: 0
          type: integer
          format: int32
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryHistory'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/changes:
    get:
      tags:
      - repositories
      summary: Returns a list of objects that have uncommitted changes.
      operationId: getChanges
      parameters:
      - name: fields
        in: query
        description: Parameter to include various additional information about changes.<br><strong>total</strong>
          - the total number of uncommitted files.<br>
        content:
          '*/*':
            schema:
              uniqueItems: true
              type: array
              items:
                type: string
                enum:
                - total
              enum:
              - total
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryUncommittedChanges'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/commits:
    post:
      tags:
      - repositories
      - repositories commits
      summary: Commits only changed objects for client to repository.
      operationId: commitChanges
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InCommitParameters'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryCommit'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/commits/{commit_id}:
    post:
      tags:
      - repositories
      - repositories commits
      summary: Imports version of provided GIT Hash to automation engine.
      operationId: moveHead
      parameters:
      - name: commit_id
        in: path
        description: GIT Hash of the target commit.
        required: true
        schema:
          type: string
        example: 1
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryRollback'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/merge:
    post:
      tags:
      - repositories
      - repositories merge
      summary: Merge another branch in active branch.
      operationId: mergeBranchIntoActive
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InMergeParameters'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryMerge'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    delete:
      tags:
      - repositories merge
      - repositories
      summary: Abort merging so we get out of merging state.
      operationId: delete
      responses:
        "200":
          description: Success
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/repositories/pull:
    post:
      tags:
      - repositories
      summary: Pull changes from repository for active branch.
      operationId: pull
      parameters: []
      requestBody:
        description: Parameters for importing after a pull. The pull will abort if
          there are conflicts and overwriting is not enabled.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InRepositoryPull'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRepositoryPull'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/scripts:
    post:
      tags:
      - scripts
      summary: Runs scripts written in the Automation Engine scripting language.
      operationId: activateScript
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InScriptsBody'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRunId'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/search:
    post:
      tags:
      - search
      summary: Search the process assembly for objects using different filter criteria.
      description: "<b>Note:</b> In order to search for objects, you need to define\
        \ at least one filter object (see below) and append it to the filter array\
        \ of the JSON payload. An object has to match every filter of your search\
        \ to be included in the result set.<br><br><b>Note:</b> The search will consider\
        \ the folder permissions of the AWI user who executed the API request - it\
        \ will not find objects that are inaccessible for this user. However, it does\
        \ not consider permissions directly configured in an object. Therefore you\
        \ should use defensive programming when processing the search results - i.e.\
        \ your code must be able to handle access violation errors.<br><br><b>Note:</b>\
        \ To sort the result set you can populate property <i>sort_columns</i>. This\
        \ <a href=\"examples/search/sort/example-name-title-sort.json\">example</a>\
        \ shows how to sort the result set after <i>name</i> ascending and <i>title</i>\
        \ descending. Following properties are supported: <i>name, type, sub_type,\
        \ platform, title, archive_key1, archive_key2, folder_path, modified_date,\
        \ last_used_date, creation_date, calendar_event_name, calendar_event_ctype,\
        \ calendar_event_valid_from, calendar_event_valid_to</i>.<br><br><table>\t\
        <thead>\t\t<tr>\t\t\t<th>filter identifier</th>\t\t\t<th>filter model</th>\t\
        \t\t<th>description</th>\t\t\t<th>example</th>\t\t</tr>\t</thead>\t<tbody>\t\
        \t<tr>\t\t\t<td><i>object_name</i></td>\t\t\t<td><a href='#model-ObjectNameFilter'>ObjectNameFilter</a></td>\t\
        \t\t<td>Searches for object names, also supports placeholder signs.</td>\t\
        \t\t<td><a href=\"examples/search/filters/example-object-name-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>calendar_event</i></td>\t\t\
        \t<td><a href='#model-CalendarEventFilter'>CalendarEventFilter</a></td>\t\t\
        \t<td>Searches for calendar events with the given event name that are valid\
        \ on the given time frame.</td>\t\t\t<td><a href=\"examples/search/filters/example-calendar-event-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>granularity</i></td>\t\t\t\
        <td><a href='#model-GranularityFilter'>GranularityFilter</a></td>\t\t\t<td>By\
        \ default, a search query returns UC4 objects. To return calendar-events,\
        \ use this \t\t\tfilter with the value <i>CALENDAR_EVENT</i> in field <i>granularity</i>.</td>\t\
        \t\t<td><a href=\"examples/search/filters/example-granularity-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>location</i></td>\t\t\t<td><a\
        \ href='#model-LocationFilter'>LocationFilter</a></td>\t\t\t<td>Finds objects\
        \ by their folder location.</td>\t\t\t<td><a href=\"examples/search/filters/example-location-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>time_frame</i></td>\t\t\t<td><a\
        \ href='#model-TimeFrameFilter'>TimeFrameFilter</a></td>\t\t\t<td>Searches\
        \ for objects that were created create/modified/used within the given \t\t\
        \ttimeframe (unix epoch dates). Note: queries for object usage only return\
        \ results if the <i>LAST_USE</i> property \t\t\thas been enabled in <i>UC_SYSTEM_SETTINGS</i>.</td>\t\
        \t\t<td><a href=\"examples/search/filters/example-time-frame-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>client</i></td>\t\t\t<td><a\
        \ href='#model-ClientFilter'>ClientFilter</a></td>\t\t\t<td>Extend the search\
        \ to objects on client 0.</td>\t\t\t<td><a href=\"examples/search/filters/example-client-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>object_id</i></td>\t\t\t<td><a\
        \ href='#model-ObjectIdFilter'>ObjectIdFilter</a></td>\t\t\t<td>Searches for\
        \ an object with the given id.</td>\t\t\t<td><a href=\"examples/search/filters/example-object-id-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>variable_key</i></td>\t\t\t\
        <td><a href='#model-VaraKeyFilter'>VaraKeyFilter</a></td>\t\t\t<td>Searches\
        \ for variable keys inside of <i>STATIC VARA</i> objects.</td>\t\t\t<td><a\
        \ href=\"examples/search/filters/example-variable-key-filter.json\">Example</a></td>\t\
        \t</tr>\t\t<tr>\t\t\t<td><i>agent</i></td>\t\t\t<td><a href='#model-AgentFilter'>AgentFilter</a></td>\t\
        \t\t<td>Searches content of the agent field in <i>JOBS</i> objects.</td>\t\
        \t\t<td><a href=\"examples/search/filters/example-agent-filter.json\">Example</a></td>\t\
        \t</tr>\t\t<tr>\t\t\t<td><i>login</i></td>\t\t\t<td><a href='#model-LoginFilter'>LoginFilter</a></td>\t\
        \t\t<td>Searches content of the login field in <i>JOBS</i> objects.</td>\t\
        \t\t<td><a href=\"examples/search/filters/example-login-filter.json\">Example</a></td>\t\
        \t</tr>\t\t<tr>\t\t\t<td><i>archive_key</i></td>\t\t\t<td><a href='#model-ArchiveKeysFilter'>ArchiveKeysFilter</a></td>\t\
        \t\t<td>Search within the archive keys of an object. Please note that an archive\
        \ key can \t\t\tonly have 32 characters, searching for longer keys will yield\
        \ empty results.</td>\t\t\t<td><a href=\"examples/search/filters/example-archive-key-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>variable_value</i></td>\t\t\
        \t<td><a href='#model-VaraValueFilter'>VaraValueFilter</a></td>\t\t\t<td>Searches\
        \ for variable keys inside of <i>STATIC VARA</i> objects.</td>\t\t\t<td><a\
        \ href=\"examples/search/filters/example-variable-value-filter.json\">Example</a></td>\t\
        \t</tr>\t\t<tr>\t\t\t<td><i>title</i></td>\t\t\t<td><a href='#model-ObjectTitleFilter'>ObjectTitleFilter</a></td>\t\
        \t\t<td>Search in object titles.</td>\t\t\t<td><a href=\"examples/search/filters/example-title-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>process</i></td>\t\t\t<td><a\
        \ href='#model-ProcessSheetFilter'>ProcessSheetFilter</a></td>\t\t\t<td>Search\
        \ in scripts of the process sheet (full-text).</td>\t\t\t<td><a href=\"examples/search/filters/example-process-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>documentation</i></td>\t\t\t\
        <td><a href='#model-DocumentationFilter'>DocumentationFilter</a></td>\t\t\t\
        <td>Search in object's documentation (full-text). Performs a full-text search\
        \ in the \t\t\tdocumentation of an object (structured and unstructured). For\
        \ structured documentation, \t\t\tthe search term will be matched against\
        \ keys and values of the documentation.</td>\t\t\t<td><a href=\"examples/search/filters/example-documentation-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>object_type</i></td>\t\t\t\
        <td><a href='#model-ObjectTypeFilter'>ObjectTypeFilter</a></td>\t\t\t<td>Finds\
        \ objects by the attribute <i>object type</i>.</td>\t\t\t<td><a href=\"examples/search/filters/example-object-type-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>platform</i></td>\t\t\t<td><a\
        \ href='#model-ObjectPlatformFilter'>ObjectPlatformFilter</a></td>\t\t\t<td>Find\
        \ objects by the attribute <i>platform</i>.</td>\t\t\t<td><a href=\"examples/search/filters/example-platform-filter.json\"\
        >Example</a></td>\t\t</tr>\t\t<tr>\t\t\t<td><i>object_sub_type</i></td>\t\t\
        \t<td><a href='#model-ObjectSubTypeFilter'>ObjectSubTypeFilter</a></td>\t\t\
        \t<td>Find objects by the attribute <i>subtype</i>.</td>\t\t\t<td><a href=\"\
        examples/search/filters/example-object-sub-type-filter.json\">Example</a></td>\t\
        \t</tr>\t</tbody></table>"
      operationId: findObjects
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InSearchBody'
        required: true
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultInfo'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/agentgroups:
    get:
      tags:
      - system
      - system agentgroups
      summary: Lists available agent groups
      operationId: list_1
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutAgentGroupList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/agentpacks:
    post:
      tags:
      - system
      - system agent packs
      summary: Creates a pre-configured agent package. The response contains a link
        to a zip file.
      operationId: createAgentPackage
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InAgentPacksBody'
        required: true
      responses:
        "400":
          description: Bad request - request data is invalid
        "201":
          description: Agent package created.
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/agentpacks/{filename}:
    get:
      tags:
      - system
      - system agent packs
      summary: Download of pre-configured agent package (agent.zip).
      description: "This endpoint is used after POST /{client_id}/system/agentpacks\
        \ to download a zip file containing the agent binaries."
      operationId: downloadAgentPackage
      parameters:
      - name: filename
        in: path
        description: "File name part of the link returned by POST /{client_id}/system/agentpacks"
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/octet-stream: {}
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/agents:
    get:
      tags:
      - system
      - system agents
      summary: Lists all agents that are defined in the system. The returned list
        contains running and stopped agents.
      operationId: list_2
      parameters:
      - name: max_results
        in: query
        description: Maximum number of executions for a page result set. If this parameter
          is omitted the default value 50 is applied.
        schema:
          minimum: 1
          type: integer
          format: int32
        example: 5000
      - name: name
        in: query
        description: Filter after the name of the agent. Supports wildcards (*).
        schema:
          type: string
        example: WIN01
      - name: active
        in: query
        description: Filter after running agents.
        schema:
          type: boolean
        example: true
      - name: ip_address
        in: query
        description: Filter after IP address. Supports wildcards (*).
        schema:
          type: string
        example: 10.243.20.155
      - name: version
        in: query
        description: Filter after the agents version. Supports wildcards (*).
        schema:
          type: string
        example: 12.3.0+low.build.1100
      - name: hardware
        in: query
        description: Filter after the computer's hardware information. Supports wildcards
          (*).
        schema:
          type: string
        example: x86/2/64
      - name: software
        in: query
        description: Filter after the Computer's operating system. Supports wildcards
          (*).
        schema:
          type: string
        example: WinNT
      - name: linked
        in: query
        description: Filter after agents that are linked to the service manager
        schema:
          type: boolean
        example: false
      - name: platform
        in: query
        description: Filter after agent platform (type). Supports wildcards (*).
        schema:
          type: string
        example: WINDOWS
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutAgentList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - system agents
      - system
      summary: Creates a new agent.
      operationId: createAgent
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InCreateAgentBody'
        required: true
      responses:
        "200":
          description: Agent created.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/agents/authentication_package:
    get:
      tags:
      - system
      - system agents
      summary: Gets the agent authentication package if LOCAL is set in UC_AS_SETTINGS.
      operationId: getCompanyKeypackage
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutAuthenticationPackage'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/agents/{object_name}:
    get:
      tags:
      - system
      - system agents
      summary: Returns detailed agent information
      operationId: getAgentDetails
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutAgent'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    delete:
      tags:
      - system agents
      - system
      summary: Deletes an existing agent.
      operationId: deleteAgent
      parameters: []
      responses:
        "200":
          description: Agent deleted.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/system/agents/{object_name}/authenticate:
    post:
      tags:
      - system
      - system agents
      summary: Authenticates a waiting agent.
      operationId: authenticate
      parameters: []
      responses:
        "200":
          description: Agent has been authenticated.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/system/agents/{object_name}/authentication_package:
    get:
      tags:
      - system
      - system agents
      summary: Gets the agent authentication package for the specified agent if LOCAL_REMOTE
        is set in UC_AS_SETTINGS.
      operationId: getKeypackage
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutAuthenticationPackage'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/system/agents/{object_name}/rename:
    post:
      tags:
      - system
      - system agents
      summary: Renames an existing agent object.
      operationId: rename
      parameters: []
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InRenameAgentBody'
        required: true
      responses:
        "200":
          description: Agent renamed.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/system/agents/{object_name}/renew_transferkey:
    post:
      tags:
      - system
      - system agents
      summary: Resets the transfer key of a non TLS agent.
      operationId: renewTransferKey
      parameters: []
      responses:
        "200":
          description: Transfer key has been cleared.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/system/agents/{object_name}/resetpublickey:
    post:
      tags:
      - system
      - system agents
      summary: Resets the public key of an agent.
      operationId: resetAgentPublicKey
      parameters: []
      responses:
        "200":
          description: Public key has been cleared.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/system/certificates:
    get:
      tags:
      - system
      - system certificates
      summary: Returns list of tls certificates of currently active JCP processes.
      operationId: getExpirationDates
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutCertificatesList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/clients:
    get:
      tags:
      - system
      - system clients
      summary: List of clients in the system.
      operationId: list_3
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutClientList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/clients/{client_id}:
    delete:
      tags:
      - system
      - system clients
      summary: Delete a client
      operationId: delete_1
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRunId'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/features:
    get:
      tags:
      - system
      summary: Retrieve system feature information.
      operationId: getFeatureList
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OutSystemFeatureList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/health:
    get:
      tags:
      - system
      summary: Can be used to determine if the automation system is in a healthy state.
      description: "A system is healthy if there is a PWP and at least one instance\
        \ of CP and JWP respectively. When healthy, HTTP 200 is returned. When unhealthy,\
        \ HTTP 503. Note: only use the HTTP status code to determine the health status\
        \ since the response body is optional."
      operationId: healthCheck
      parameters:
      - name: details
        in: query
        description: Parameter to include additional information about processes.
        content:
          '*/*':
            schema:
              type: boolean
              enum:
              - true
              - false
              default: false
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutHealthCheck'
        "503":
          description: Service Unavailable.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/metrics/prometheus:
    get:
      tags:
      - system
      - system metrics
      summary: Retrieve the AE performance metrics for the last scrapeIntervalSeconds
        as prometheus format
      description: "System variables will be considered. If not set default values\
        \ will be used.<br><ul><li>PERFORMANCE_ACTIVE (Default value: N)</li><li>PERFORMANCE_KEEP_DAYS\
        \ (Default value: 30)</li><li>PERFORMANCE_CLEAN_UP_BATCH_SIZE (Default value:\
        \ 900)</li></ul>"
      operationId: allPrometheusMetrics
      parameters:
      - name: scrapeIntervalSeconds
        in: query
        description: Defines how many seconds in the past to aggregate
        schema:
          type: integer
          format: int32
          default: 60
      responses:
        default:
          description: default response
          content:
            text/plain: {}
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/ra-solutions:
    get:
      tags:
      - system
      - system RA solutions
      summary: Lists all installed RA solutions.
      description: Only works for client 0.
      operationId: list_4
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRASolutionsList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    post:
      tags:
      - system RA solutions
      - system
      summary: Install/update RA solution.
      description: Only works for client 0.
      operationId: installOrUpdate
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InRASolutionBody'
        required: true
      responses:
        "200":
          description: Installation or update was successful.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/ra-solutions/upload:
    post:
      tags:
      - system
      - system RA solutions
      summary: 'Install/update RA solution with binary upload. '
      description: Only works for client 0.
      operationId: upload
      parameters:
      - name: checksum
        in: header
        schema:
          type: string
      - name: algorithm
        in: header
        schema:
          type: string
          default: MD5
      - name: ignore-signature
        in: header
        schema:
          type: boolean
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
        required: true
      responses:
        "200":
          description: Installation or update was successful.
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/system/ra-solutions/{object_name}:
    get:
      tags:
      - system
      - system RA solutions
      summary: Returns detailed RA solution information.
      description: Only works for client 0.
      operationId: getRASolutionDetails
      parameters: []
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutRASolution'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
    - name: object_name
      in: path
      description: Name of the object.
      required: true
      schema:
        type: string
  /{client_id}/system/metrics:
    get:
      tags:
      - system metrics
      summary: Retrieve the AE historic performance metrics with extended filter options
      operationId: historicMetrics
      parameters:
      - name: type
        in: query
        description: Defines which type of metric should be returned
        required: true
        schema:
          type: string
        example: BusyValues
      - name: time_frame_from
        in: query
        description: Timeframe lower bound to be used for the query.
        schema:
          pattern: "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])T(?:[01]\\\
            d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$"
          type: string
        example: 2015-04-15T06:37:59Z
      - name: time_frame_to
        in: query
        description: Timeframe upper bound to be used for the query.
        schema:
          pattern: "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])T(?:[01]\\\
            d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$"
          type: string
        example: 2015-04-15T06:37:59Z
      responses:
        default:
          description: default response
          content:
            application/json: {}
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/telemetry/export/{start_from}:
    get:
      tags:
      - telemetry
      summary: "Retrieve telemetry data per month as json for the last n months, including\
        \ the current month."
      description: "Only works for client 0.Requests for sample use-cases: <br><ul>\t\
        <li><a href=\"examples/telemetry/example-export.txt\">Use Case:</a> Export\
        \ Telemetry data for last month and this month by setting 'start_from' to\
        \ 2.</li></ul>"
      operationId: export
      parameters:
      - name: start_from
        in: path
        description: Timeframe lower bound to be used for the query.
        required: true
        schema:
          type: integer
          format: int32
        example: 2
      responses:
        "200":
          description: successful operation
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
  /{client_id}/telemetry/products:
    get:
      tags:
      - telemetry
      summary: Retrieve available products
      operationId: productList
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutTelemetryProductList'
        "400":
          description: Bad request - request data is invalid
        "401":
          description: Unauthorized access - login data not valid.
        "403":
          description: Forbidden - the user is not allowed to access the resource.
        "404":
          description: The resource is not available.
        "405":
          description: Method not allowed.
        "500":
          description: Internal error occurred.
    parameters:
    - name: client_id
      in: path
      description: Number/ID of the client.
      required: true
      schema:
        type: string
components:
  schemas:
    OutErtEstimations:
      type: object
      properties:
        estimated_erts:
          type: object
          additionalProperties:
            type: integer
            description: A map with runId -> estimated time in seconds for the contained
              tasks.
            format: int64
          description: A map with runId -> estimated time in seconds for the contained
            tasks.
        estimated_start_times:
          type: object
          additionalProperties:
            type: integer
            description: A map with runId -> estimated start time in UTC millis for
              the yet not started tasks.
            format: int64
          description: A map with runId -> estimated start time in UTC millis for
            the yet not started tasks.
        longest_path_vertex_keys:
          type: object
          additionalProperties:
            type: array
            description: A list that comprises runIds of the longest path
            items:
              $ref: '#/components/schemas/VertexKey'
          description: A list that comprises runIds of the longest path
        ert:
          type: integer
          description: The ERT for the estimated workflow.
          format: int64
        rrt:
          type: integer
          description: The RRT for the estimated workflow.
          format: int64
      description: Response that is sent when the ERT of a workflow is recomputed.
    VertexKey:
      type: object
      properties:
        parent_run_id:
          type: integer
          format: int32
        run_id:
          type: integer
          format: int32
        lnr:
          type: integer
          format: int32
        child_loop_index:
          type: integer
          format: int32
      description: A list that comprises runIds of the longest path
    OutRunId:
      required:
      - run_id
      type: object
      properties:
        run_id:
          type: integer
          format: int32
          example: 1001345
    OutValidationError:
      required:
      - code
      - error
      - invalid_value
      - path
      type: object
      properties:
        code:
          type: integer
          description: Error Code.
          format: int32
          example: 45113
        error:
          type: string
          description: Message that roughly describes the error.
          example: Given string is not a valid object name.
        path:
          type: string
          description: The full path of the invalid property.
          example: object_name
        invalid_value:
          type: object
          description: The invalid value.
          example: null
    OutError:
      required:
      - code
      - details
      - error
      type: object
      properties:
        code:
          type: integer
          description: Error Code.
          format: int32
          example: 45106
        error:
          type: string
          description: Message that roughly describes the error.
          example: The request is invalid and cannot be processed by the Automation
            Engine.
        details:
          type: string
          description: 'Additional message that describes the error in more detail.
            If no '
          example: The object to be executed is not an executable one.
    InCalendarEventListEntry:
      type: object
      properties:
        calendar:
          type: string
          description: Name of a calendar object.
        event:
          type: string
          description: Name of a calendar event
      description: Calendar events which defines possible days for recurring executions.
      example:
      - calendar: CALE.WORKDAYS
        event: VACATION
      - calendar: CALE.BUSY
        event: JOUR_FIX
    InExecutionBody:
      required:
      - executionOption
      - objectName
      type: object
      properties:
        objectName:
          type: string
          description: Name of the object to be executed.
          example: SCRI.NEW.1
        executionOption:
          type: string
          description: Type of execution.
          example: execute
          enum:
          - execute
          - once
          - recurring
        inputs:
          type: object
          additionalProperties:
            type: object
            description: Optional list of promptsets variables to be passed.
          description: Optional list of promptsets variables to be passed.
        alias:
          type: string
          description: Optional alias object should be executed as.
          example: SCRI.NEW.1.MONDAY
        timezone:
          type: string
          description: Timezone used for the execution date/time and logical date/time.
          example: TZ.MEZ
        queue:
          type: string
          description: Queue in which the object should be activated.
          example: CLIENT_QUEUE
        callback:
          $ref: '#/components/schemas/InExecutionCallbackBody'
        once:
          $ref: '#/components/schemas/InExecutionOnceBody'
        recurring:
          $ref: '#/components/schemas/InExecutionRecurringBody'
    InExecutionCallbackBody:
      type: object
      properties:
        type:
          type: string
          description: Type of callback.
          example: http
          enum:
          - http
        recurringMode:
          type: string
          description: Execute callback once at the end of all executions or for each
            execution.
          example: once
          enum:
          - once
          - each
        http:
          $ref: '#/components/schemas/InExecutionCallbackHttpBody'
      description: Settings for an optional execution callback.
    InExecutionCallbackHttpBody:
      required:
      - url
      type: object
      properties:
        url:
          type: string
          description: Url to call when the callback is triggered. Must be publicly
            accessible and return http status 200.
          example: https://my-domain.com/callback?token=12345
        headers:
          type: object
          additionalProperties:
            type: string
            description: Headers to set for the HTTP/S callback.
            example: "{\"Authorization\":\"Bearer 135345f1232a34543b34fff\"}"
          description: Headers to set for the HTTP/S callback.
          example:
            Authorization: Bearer 135345f1232a34543b34fff
      description: Settings for an optional HTTP/S callback.
    InExecutionOnceBody:
      type: object
      properties:
        executionDateTime:
          type: string
          description: "Date and Time when the object should be executed. If no start\
            \ time has been specified, the object is executed immediately."
          example: 2015-04-15T06:37:59Z
        waitForManualRelease:
          type: boolean
          description: "Determinates, if the object should be manually released to\
            \ start. Only relevant if object is executed immediately (= no start time)."
          example: false
        useLogicalTime:
          type: string
          description: Logical Start time for object start.
          example: 2015-04-15T06:37:59Z
      description: "Settings for the execution option: once."
    InExecutionRecurringBody:
      type: object
      properties:
        periodDescription:
          type: string
          description: Description for the executed period container.
        startDate:
          type: string
          description: "Earliest start date of the recurring executions. Required\
            \ date format: yyyy-MM-dd"
          example: 2018-02-18
        endDate:
          type: string
          description: "End date for the period exeuctions. Must not be specified\
            \ together with end_after_executions. Required date format: yyyy-MM-dd"
          example: 2018-02-19
        endAfterExecutions:
          type: integer
          description: End the period container after a specific number of executions.
            Must not be specified together with end_date.
          format: int32
          example: 5
        executeAt:
          type: string
          description: "Start recurring executions at one specific time. Must not\
            \ be specified together with execute_interval and / or execute_after.\
            \ Required time format: HH:MM"
          example: 23:59
        executeInterval:
          type: string
          description: "Activate executions in specific intervals. Must not be specified\
            \ together with execute_at and / or execute_after. Required format: PnDTnHnMnS"
          example: P12DT7H34M
        executeAfter:
          type: string
          description: "Time gap between recurring executions. Must not be specified\
            \ together with execute_at and / or execute_interval. Required format:\
            \ PnDTnHnMnS"
          example: P12DT7H34M
        allowOneOverlap:
          type: boolean
          description: "Defines if an recurring execution may start, if the previous\
            \ is still active. Default: false"
        betweenStart:
          type: string
          description: "Start of the timespan for recurring executions. Required format:\
            \ HH:SS"
          example: 12:00
        betweenEnd:
          type: string
          description: "End of the timespan for recurring executions. Required format:\
            \ HH:SS"
          example: 15:00
        executeWeekly:
          type: array
          items:
            type: string
            description: List of Weekdays for recurring executions. Must not be used
              together with execute_calendar_list.
            example: "[\"mon\",\"thu\",\"sat\"]"
            enum:
            - mon
            - tue
            - wed
            - thu
            - fri
            - sat
            - sun
        executeCalendarMatch:
          type: string
          description: "Condition for calendar event list. Allowed values: 'all',\
            \ 'none' or 'one'"
          example: all
          enum:
          - one
          - none
          - all
        adjustStartTime:
          type: boolean
          description: Defines if adjustment of the start time should be forced on
            the defined time window.
        executeCalendarList:
          type: array
          items:
            $ref: '#/components/schemas/InCalendarEventListEntry'
      description: "Settings for the execution option: recurring."
    OutComment:
      required:
      - comment
      - timestamp
      type: object
      properties:
        timestamp:
          type: string
          description: Creation timestamp of the comment.
          format: date-time
          example: 2017-11-13T13:13:18Z
        comment:
          type: string
          description: The comment value.
          example: good run
        user:
          type: string
          description: The user that created the comment.
          example: AUTOMIC/AUTOMIC
    OutExecution:
      required:
      - activation_time
      - name
      - queue
      - run_id
      - status
      - status_text
      - type
      - user
      type: object
      properties:
        name:
          type: string
          description: Name of the executed object
          example: WIN.START_TOMCAT
        type:
          type: string
          description: Type of the execution.
          example: Job
          enum:
          - AgentGroup Container
          - CallAPI
          - Cockpit
          - Dynamic Job
          - Event
          - FileTransfer
          - Group
          - Job
          - Notification
          - Period Container
          - RemoteTaskManager
          - Report
          - Schedule
          - Script
          - Workflow
        sub_type:
          type: string
          description: Sub type of the execution.
          example: FE
        queue:
          type: string
          description: Name of the queue in which the task is executed
          example: CLIENT_QUEUE
        run_id:
          type: integer
          description: RunID of the execution
          format: int32
          example: 2003103
        status:
          type: integer
          description: Current status of execution
          format: int32
          example: 1900
        status_text:
          type: string
          description: Status text of execution
          example: ENDED_OK - Task ended normally.
        runtime:
          type: integer
          description: Total duration in seconds
          format: int32
          example: 60
        description:
          type: string
          description: Description text of the executed object.
          example: The best task ever
        activation_time:
          type: string
          description: Time the execution was activated.
          format: date-time
          example: 2015-04-15T06:37:59Z
        start_time:
          type: string
          description: Time the execution was started.
          format: date-time
          example: 2015-04-15T06:37:59Z
        end_time:
          type: string
          description: Time the execution ended.
          format: date-time
          example: 2015-04-15T06:38:59Z
        agent:
          type: string
          description: Name of agent that ran the execution (agent related executions
            only).
          example: WIN01
        platform:
          type: string
          description: Platform of agent that ran the execution (agent related executions
            only).
          example: WIN64
        parent:
          type: integer
          description: RunID of the parent execution (subordinated tasks only).
          format: int32
          example: 2003101
        reference_run_id:
          type: integer
          description: "RunID of the original execution, zero if this was not a restart."
          format: int32
          example: 2003102
        line_number:
          type: integer
          description: Line number within the executed workflow or schedule.
          format: int32
          example: 3
        user:
          type: string
          description: Name of the user (user object) that started the execution.
          example: AUTOMIC/AUTOMIC
        estimated_runtime:
          type: integer
          description: Estimated runtime of the execution.
          format: int32
          example: 1
        archive_key1:
          type: string
          description: Archive key1 for execution
          example: key1
        archive_key2:
          type: string
          description: Archive key2 for execution
          example: key2
        title:
          type: string
          description: Title of the execution
          example: SCRI.NEW.1
        alias:
          type: string
          description: Alias of the execution
          example: SCRI.NEW.1.ALIAS
        activator:
          type: integer
          description: RunID of the activator.
          format: int32
          example: 2003101
        activator_object_type:
          type: string
          description: Start type that describes what caused the execution to be started.
          example: JOBP
          enum:
          - JOBP
          - JOBP
          - JSCH
          - JSCH
          - HOSTG
          - HOSTG
          - HOSTG
          - ONCE
          - PERIOD
          - EVNT
          - API
          - AUTO
          - CAU
          - CLNTDEL
          - DIALOG
          - JAVA API
          - JOBG
          - JOBS
          - OBJECT
          - SCRI
          - SCRI
        variables:
          type: object
          additionalProperties:
            type: object
            description: Optional list of variables.
          description: Optional list of variables.
        comments:
          type: array
          description: Optional list of comments.
          items:
            $ref: '#/components/schemas/OutComment'
        reports:
          type: array
          description: Optional list of reports.
          items:
            $ref: '#/components/schemas/OutReport'
        restarts:
          type: integer
          description: Optional number of total restarts.
          format: int32
        restart_count:
          type: integer
          description: Optional number of this restart.
          format: int32
        restart_predecessor:
          type: integer
          description: Optional RunID of the restart predecessor.
          format: int32
        predecessors:
          type: array
          description: Optional workflow task predecessors.
          items:
            $ref: '#/components/schemas/OutPredecessorTaskInfo'
        recurring:
          $ref: '#/components/schemas/OutExecutionRecurringBody'
        event_id:
          type: integer
          description: Original RunID for events or the RunID of the first period
            for schedules and periodic container.
          format: int32
    OutExecutionList:
      required:
      - data
      - hasmore
      - total
      type: object
      properties:
        total:
          type: integer
          description: Determines the total number of items.
          format: int32
          example: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutExecution'
        hasmore:
          type: boolean
          description: Indicates if there are more results than currently returned.
          example: false
    OutExecutionRecurringBody:
      type: object
      properties:
        period_description:
          type: string
          description: Description for the executed period container.
        start_date:
          type: string
          description: "Earliest start date of the recurring executions. Date format:\
            \ yyyy-MM-dd"
          example: 2018-02-18
        end_date:
          type: string
          description: "End date for the period exeuctions. Date format: yyyy-MM-dd"
          example: 2018-02-19
        end_after_executions:
          type: integer
          description: End the period container after a specific number of executions.
          format: int32
          example: 5
        execute_at:
          type: string
          description: "Start recurring executions at one specific time. Time format:\
            \ HH:MM"
          example: 23:59
        execute_interval:
          type: string
          description: "Activate executions in specific intervals. Format: PnDTnHnMnS"
          example: P12DT7H34M
        execute_after:
          type: string
          description: "Time gap between recurring executions. Format: PnDTnHnMnS"
          example: P12DT7H34M
        allow_one_overlap:
          type: boolean
          description: "Defines if an recurring execution may start, if the previous\
            \ is still active. Default: false"
        between_start:
          type: string
          description: "Start of the timespan for recurring executions. Format: HH:SS"
          example: 12:00
        between_end:
          type: string
          description: "End of the timespan for recurring executions. Format: HH:SS"
          example: 15:00
        adjust_start_time:
          type: boolean
          description: Defines if adjustment of the start time should be forced on
            the defined time window.
        execute_weekly:
          type: array
          items:
            type: string
            description: List of Weekdays for recurring executions.
            enum:
            - mon
            - tue
            - wed
            - thu
            - fri
            - sat
            - sun
        execute_calendar_match:
          type: string
          description: "Condition for calendar event list. Allowed values: 'all',\
            \ 'none' or 'one'"
          example: all
          enum:
          - one
          - none
          - all
        execute_calendar_list:
          type: array
          items:
            $ref: '#/components/schemas/InCalendarEventListEntry'
        occur_count:
          type: integer
          description: Number of already executed runs.
          format: int32
        next_check:
          type: string
          description: Timestamp of the next possible run.
          format: date-time
      description: "Settings for the execution option: recurring. All returned dates\
        \ and times are converted to UTC."
    OutPredecessorTaskInfo:
      required:
      - run_id
      type: object
      properties:
        run_id:
          type: integer
          description: RunId of the predecessor task
          format: int32
          example: 123456
        object_name:
          type: string
          description: Name of the predecessor task
          example: JOBS.WIN
        status:
          type: integer
          description: Status of the predecessor task
          format: int32
          example: 1900
      description: Optional workflow task predecessors.
    OutReport:
      required:
      - end_timestamp
      - is_db
      - is_xml
      - type
      type: object
      properties:
        end_timestamp:
          type: string
          description: Timestamp when report has been finished
          format: date-time
          example: 2017-11-13T13:13:18Z
        type:
          type: string
          description: Report type shortcut
          example: REP
        is_xml:
          type: boolean
          description: Flag if report stored in XML Format
          example: false
        is_db:
          type: boolean
          description: Flag if report stored in Database
          example: true
    InAddCommentBody:
      required:
      - comment
      type: object
      properties:
        comment:
          maxLength: 1024
          minLength: 0
          type: string
          description: The comment that should be added to the execution.
          example: Example comment.
    OutReportContent:
      required:
      - content
      - page
      type: object
      properties:
        page:
          type: integer
          description: Report page number
          format: int32
          example: 1
        content:
          type: string
          description: Report page content
          example: Test output
    OutChangeExecutionStatus:
      type: object
      properties:
        run_id:
          type: integer
          description: "The runId of the restarted execution is returned when invoking\
            \ /execution/{runId}/restart for the original execution."
          format: int32
      description: Response that is sent when the status of an execution has been
        changed.
    CancelOptions:
      type: object
      properties:
        recursive:
          type: boolean
          description: Consider child tasks if set to true.
      description: "Settings for the action: cancel."
    InChangeExecutionStatusBody:
      required:
      - action
      type: object
      properties:
        action:
          type: string
          enum:
          - restart
          - cancel
        cancel:
          $ref: '#/components/schemas/CancelOptions'
        restart:
          $ref: '#/components/schemas/RestartOptions'
    RestartOptions:
      type: object
      properties:
        queue:
          type: string
          description: Queue in which the object should be activated.
          example: CLIENT_QUEUE
        restart_point:
          maxLength: 8
          minLength: 0
          type: string
          description: Defined point in Automic script where to restart execution.
          example: RP1
        keep_start_type:
          type: boolean
          description: "Set true if you want the task to keep its start type. For\
            \ example, if a group has been assigned to the object, restarting will\
            \ take place within the group."
          example: false
        wait_for_manual_release:
          type: boolean
          description: Execution waits to be released before actual execution.
          example: false
        inputs:
          type: object
          additionalProperties:
            type: object
            description: Optional list of promptsets variables to be passed.
          description: Optional list of promptsets variables to be passed.
      description: "Settings for the action: restart."
    OutForecastId:
      required:
      - forecast_id
      type: object
      properties:
        forecast_id:
          type: string
    InForecastBody:
      required:
      - forecast_option
      type: object
      properties:
        forecast_option:
          type: string
          description: Type of forecast.
          example: object
          enum:
          - object
          - execution
          - client
        object:
          $ref: '#/components/schemas/InForecastObjectBody'
        execution:
          $ref: '#/components/schemas/InForecastExecutionBody'
    InForecastExecutionBody:
      required:
      - run_id
      - title
      type: object
      properties:
        run_id:
          type: integer
          description: Id of the execution to be forecasted.
          format: int32
          example: 100100
        days:
          type: integer
          description: Observation period in days from now until midnight of the last
            day. Executions running past midnight will be completely forecasted.
          format: int32
          example: 1
        title:
          type: string
          description: Name of the forecast.
        ert_group_option:
          type: string
          description: "Set ert calculation option for groups. Default value: registration"
          example: registration
          enum:
          - registration
          - group
          - fixed
        fixed:
          type: integer
          description: Fixed ERT value for groups in seconds. Only required if ert_group_option=fixed.
            Value must be 0 < x < 7200.
          format: int32
          example: 1
      description: "Settings for the forecast option: execution."
    InForecastObjectBody:
      required:
      - name
      - start
      - title
      type: object
      properties:
        name:
          type: string
          description: Name of the object to forecast.
          example: SCRI.NEW.1
        start:
          type: string
          description: Start Date and Time with which the object should be forecasted.
          example: 2015-04-15T06:37:59Z
        title:
          type: string
          description: Name of the forecast.
        ert_group_option:
          type: string
          description: "Set ert calculation option for groups. Default value: registration"
          example: group
          enum:
          - registration
          - group
          - fixed
        fixed:
          type: integer
          description: Fixed ERT value for groups in seconds. Only required if ert_group_option=fixed.
            Value must be 0 < x <= 43200.
          format: int32
          example: 1
      description: "Settings for the forecast option: object."
    OutIdList:
      required:
      - ids
      type: object
      properties:
        ids:
          uniqueItems: true
          type: array
          items:
            type: integer
            description: Set of forecast ids that were not deleted and can only be
              deleted with force flag set to true.
            format: int32
    InForecastDeleteBody:
      required:
      - ids
      type: object
      properties:
        ids:
          uniqueItems: true
          type: array
          items:
            type: integer
            description: Ids to delete.
            format: int32
        force:
          type: boolean
          description: Force deletion of unfinished forecasts.
          example: false
    OutForecast:
      required:
      - end_time
      - id
      - start_time
      - status
      - status_text
      - title
      - type
      - user
      type: object
      properties:
        id:
          type: integer
          description: ID of the forecast.
          format: int32
          example: 2003103
        title:
          type: string
          description: Title of the forecast.
          example: FC.SCRI.1
        start_time:
          type: string
          description: Start time of the forecast calculation.
          format: date-time
          example: 2015-04-15T06:37:59Z
        end_time:
          type: string
          description: End time of the forecast calculation.
          format: date-time
          example: 2015-04-15T06:37:59Z
        estimated_start:
          type: string
          description: Logical start time of the forecast.
          format: date-time
          example: 2015-04-15T06:37:59Z
        estimated_end:
          type: string
          description: Logical end time of the forecast.
          format: date-time
          example: 2015-04-15T06:37:59Z
        status:
          type: integer
          description: Status of the forecast calculation.
          format: int32
          example: 1900
        status_text:
          type: string
          description: Status text of the forecast calculation.
          example: ENDED_OK - ended normally
        user:
          type: string
          description: User who started the forecast calculation.
          example: UC
        last_error_message:
          type: string
          description: Last error message during forecast calculation.
          example: Forecast cannot be calculated for object.
        last_error_code:
          type: integer
          description: Last error code during forecast calculation.
          format: int32
          example: 45273
        entries:
          type: array
          description: Objects or tasks that were forecasted.
          items:
            $ref: '#/components/schemas/OutForecastEntry'
        type:
          type: string
          description: Type of the forecast.
          example: FCST
    OutForecastEntry:
      required:
      - id
      - name
      - parent
      - type
      type: object
      properties:
        id:
          type: integer
          description: ID of the forecast entry.
          format: int32
          example: 2003103
        parent:
          type: integer
          description: Parent ID of the forecast entry.
          format: int32
          example: 2003103
        name:
          type: string
          description: Name of the forecasted object.
          example: SCRI.NEW.1
        type:
          type: string
          description: Type of the forecasted object.
          example: SCRI
        container_type:
          type: string
        estimated_start:
          type: string
          description: Estimated start time of the forecasted object.
          format: date-time
          example: 2015-04-15T06:37:59Z
        estimated_end:
          type: string
          description: Estimated end time of the forecasted object.
          format: date-time
          example: 2015-04-15T06:37:59Z
        estimated_runtime:
          type: integer
          description: Estimated run time of the forecasted object in seconds.
          format: int32
          example: 1
        agent_source:
          type: string
          description: Estimated source agent.
          example: WIN01
        agent_destination:
          type: string
          description: Estimated destination agent.
          example: UNIX01
        platform_destination:
          type: string
          description: Estimated destination agent platform.
          example: UNIX
        status:
          type: integer
          description: Estimated status of the forecasted object.
          format: int32
          example: 1900
        status_text:
          type: string
          description: Estimated status text of the forecasted object.
          example: ENDED_OK - ended normally
        login_source:
          type: string
          description: Estimated source login.
          example: LOGIN
        login_destination:
          type: string
          description: Estimated destination login.
          example: LOGIN
      description: Objects or tasks that were forecasted.
    OutForecastAgent:
      required:
      - agent
      - slots
      type: object
      properties:
        agent:
          type: string
          description: Name of the agent.
          example: WIN01
        slots:
          type: array
          description: Slots of the agent.
          items:
            $ref: '#/components/schemas/OutForecastAgentSlot'
    OutForecastAgentList:
      required:
      - data
      - hasmore
      - total
      type: object
      properties:
        total:
          type: integer
          description: Determines the total number of items.
          format: int32
          example: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutForecastAgent'
        hasmore:
          type: boolean
          description: Indicates if there are more results than currently returned.
          example: false
    OutForecastAgentSlot:
      type: object
      properties:
        from:
          type: string
          description: Start time of the slot.
          format: date-time
          example: 2019-10-12T10:00:00Z
        to:
          type: string
          description: End time of the slot.
          format: date-time
          example: 2019-10-12T19:11:34Z
        duration:
          type: string
          description: Duration of the slot.
          example: PT9H11M34S
      description: Slots of the agent.
    OutForecastList:
      required:
      - data
      - hasmore
      - total
      type: object
      properties:
        total:
          type: integer
          description: Determines the total number of items.
          format: int32
          example: 1
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutForecast'
        hasmore:
          type: boolean
          description: Indicates if there are more results than currently returned.
          example: false
    InModifyForecastBody:
      required:
      - title
      type: object
      properties:
        title:
          type: string
    ApiDocAEFolder:
      title: Folder
      type: object
      properties:
        fold:
          $ref: '#/components/schemas/fold'
    ApiDocCale:
      title: Calendar
      type: object
      properties:
        cale:
          $ref: '#/components/schemas/cale'
    ApiDocCall:
      title: Notification
      type: object
      properties:
        call:
          $ref: '#/components/schemas/call'
    ApiDocCode:
      title: Code Table
      type: object
      properties:
        code:
          $ref: '#/components/schemas/code'
    ApiDocConn:
      title: Connection
      type: object
      properties:
        conn:
          $ref: '#/components/schemas/Conn'
    ApiDocDash:
      title: Dashboard
      type: object
      properties:
        dash:
          $ref: '#/components/schemas/Dash'
    ApiDocDocu:
      title: Documentation
      type: object
      properties:
        docu:
          $ref: '#/components/schemas/Docu'
    ApiDocEvnt:
      title: Event
      type: object
      properties:
        evnt:
          $ref: '#/components/schemas/evnt'
    ApiDocFilter:
      title: Filter
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/filter'
    ApiDocFolderContent:
      title: Link/Object/Folder
      type: object
      description: Object data
      anyOf:
      - $ref: '#/components/schemas/ApiDocHostg'
      - $ref: '#/components/schemas/ApiDocHsta'
      - $ref: '#/components/schemas/ApiDocCale'
      - $ref: '#/components/schemas/ApiDocCode'
      - $ref: '#/components/schemas/ApiDocConn'
      - $ref: '#/components/schemas/ApiDocDash'
      - $ref: '#/components/schemas/ApiDocDocu'
      - $ref: '#/components/schemas/ApiDocEvnt'
      - $ref: '#/components/schemas/ApiDocJobf'
      - $ref: '#/components/schemas/ApiDocFilter'
      - $ref: '#/components/schemas/ApiDocAEFolder'
      - $ref: '#/components/schemas/ApiDocJobi'
      - $ref: '#/components/schemas/ApiDocJobs'
      - $ref: '#/components/schemas/ApiDocJobg'
      - $ref: '#/components/schemas/ApiDocLink'
      - $ref: '#/components/schemas/ApiDocLogin'
      - $ref: '#/components/schemas/ApiDocCall'
      - $ref: '#/components/schemas/ApiDocPeriod'
      - $ref: '#/components/schemas/ApiDocPrpt'
      - $ref: '#/components/schemas/ApiDocQueue'
      - $ref: '#/components/schemas/ApiDocJobq'
      - $ref: '#/components/schemas/ApiDocJsch'
      - $ref: '#/components/schemas/ApiDocScri'
      - $ref: '#/components/schemas/ApiDocSlo'
      - $ref: '#/components/schemas/ApiDocStore'
      - $ref: '#/components/schemas/ApiDocXsl'
      - $ref: '#/components/schemas/ApiDocSync'
      - $ref: '#/components/schemas/ApiDocTz'
      - $ref: '#/components/schemas/ApiDocUser'
      - $ref: '#/components/schemas/ApiDocUsrg'
      - $ref: '#/components/schemas/ApiDocVara'
      - $ref: '#/components/schemas/ApiDocJobp'
    ApiDocHostg:
      title: Agent Group
      type: object
      properties:
        hostg:
          $ref: '#/components/schemas/Hostg'
    ApiDocHsta:
      title: Agent/Client Assignment
      type: object
      properties:
        hsta:
          $ref: '#/components/schemas/Hsta'
    ApiDocJobf:
      title: File Transfer
      type: object
      properties:
        jobf:
          $ref: '#/components/schemas/jobf'
    ApiDocJobg:
      title: Job Group
      type: object
      properties:
        jobg:
          $ref: '#/components/schemas/jobg'
    ApiDocJobi:
      title: Include
      type: object
      properties:
        jobi:
          $ref: '#/components/schemas/Jobi'
    ApiDocJobp:
      title: Workflow
      type: object
      properties:
        jobp:
          $ref: '#/components/schemas/jobp'
    ApiDocJobq:
      title: Remote Task Manager
      type: object
      properties:
        jobq:
          $ref: '#/components/schemas/jobq'
    ApiDocJobs:
      title: Job
      type: object
      properties:
        jobs:
          $ref: '#/components/schemas/jobs'
    ApiDocJsch:
      title: Schedule
      type: object
      properties:
        jsch:
          $ref: '#/components/schemas/jsch'
    ApiDocLink:
      title: Link
      type: object
      properties:
        link:
          $ref: '#/components/schemas/link'
    ApiDocLogin:
      title: Login
      type: object
      properties:
        login:
          $ref: '#/components/schemas/login'
    ApiDocPeriod:
      title: Period
      type: object
      properties:
        period:
          $ref: '#/components/schemas/Period'
    ApiDocPrpt:
      title: PromptSet
      type: object
      properties:
        prpt:
          $ref: '#/components/schemas/prpt'
    ApiDocQueue:
      title: Queue
      type: object
      properties:
        queue:
          $ref: '#/components/schemas/queue'
    ApiDocScri:
      title: Script
      type: object
      properties:
        scri:
          $ref: '#/components/schemas/scri'
    ApiDocSlo:
      title: Service Level Objective
      type: object
      properties:
        slo:
          $ref: '#/components/schemas/slo'
    ApiDocStore:
      title: Storage
      type: object
      properties:
        store:
          $ref: '#/components/schemas/Store'
    ApiDocSync:
      title: Sync
      type: object
      properties:
        sync:
          $ref: '#/components/schemas/sync'
    ApiDocTz:
      title: Time Zone
      type: object
      properties:
        tz:
          $ref: '#/components/schemas/Tz'
    ApiDocUser:
      title: User
      type: object
      properties:
        user:
          $ref: '#/components/schemas/User'
    ApiDocUsrg:
      title: User Group
      type: object
      properties:
        usrg:
          $ref: '#/components/schemas/Usrg'
    ApiDocVara:
      title: Variable
      type: object
      properties:
        vara:
          $ref: '#/components/schemas/vara'
    ApiDocXsl:
      title: Style Sheet
      type: object
      properties:
        xsl:
          $ref: '#/components/schemas/xsl'
    Conn:
      title: Connection
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        connection_attributes:
          $ref: '#/components/schemas/connection_attributes'
        extended_values:
          type: array
          items:
            $ref: '#/components/schemas/extended_values'
      description: 'Connection objects contain the parameters that make the communication
        between the Automation Engine and certain solutions possible. '
    Dash:
      title: Dashboard
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
      description: Content is stored Base64 encoded as documentation of type DASH
    Docu:
      title: Documentation
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
    FolderGeneralAttributes:
      title: general_attributes
      required:
      - name
      - type
      type: object
      properties:
        type:
          maxLength: 8
          minLength: 0
          type: string
          description: Type of the object.
        name:
          maxLength: 200
          type: string
          description: Name of the object.
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Description of the object.
      description: The header of the object.
    Hostg:
      title: Agent Group
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        agent_group_attributes:
          $ref: '#/components/schemas/agent_group_attributes'
        agent_group_filters:
          type: array
          items:
            $ref: '#/components/schemas/agent_group_filters'
        agent_authorizations:
          type: array
          items:
            $ref: '#/components/schemas/agent_authorizations'
    Hsta:
      title: Agent/Client Assignment
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        agent_authorizations:
          type: array
          items:
            $ref: '#/components/schemas/agent_authorizations'
        agent_authorization_filters:
          type: array
          items:
            $ref: '#/components/schemas/agent_authorization_filters'
        authorizations:
          type: array
          items:
            $ref: '#/components/schemas/authorizations'
    Jobi:
      title: Include
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        scripts:
          $ref: '#/components/schemas/ScriptsProcessOnly'
    LinkGeneralAttributes:
      title: general_attributes
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the object.
      description: The header of a link.
    OutFolderExportWarnings:
      title: Export warnings
      type: object
      properties:
        unresolved_external_references:
          uniqueItems: true
          type: array
          items:
            type: string
            description: Name of a link that was exported without a corresponding
              object definition.
        access_denied:
          uniqueItems: true
          type: array
          items:
            type: string
            description: Name of an object that was skipped because of a missing read
              permission.
      description: Warning that a folder export may be incomplete.
    OutFolderObjects:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/folder'
        warnings:
          $ref: '#/components/schemas/OutFolderExportWarnings'
    Period:
      title: Period
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        period_attributes:
          $ref: '#/components/schemas/period_attributes'
        calendars:
          type: array
          items:
            $ref: '#/components/schemas/calendars'
    ScriptsOfEvent:
      type: object
      properties:
        pre_process:
          type: array
          items:
            type: string
            description: Line of the Process page.
        process:
          type: array
          items:
            type: string
            description: Line of the Event Process page.
      description: Process pages of an Event object.
    ScriptsOfJob:
      type: object
      properties:
        pre_process:
          type: array
          items:
            type: string
            description: Line of the Pre-Process page.
        process:
          type: array
          items:
            type: string
            description: Line of the Process page.
        post_process:
          type: array
          items:
            type: string
            description: Line of the Post Process page.
        child_post_process:
          type: array
          items:
            type: string
            description: Line of the Child Post-Process page.
      description: Process pages of a Job.
    ScriptsProcessOnly:
      type: object
      properties:
        process:
          type: array
          items:
            type: string
            description: Line of the Process page.
      description: Process page
    ScriptsWithPost:
      type: object
      properties:
        process:
          type: array
          items:
            type: string
            description: Line of the Process page.
        post_process:
          type: array
          items:
            type: string
            description: Line of the Post Process page.
      description: Process and Post Process
    Store:
      title: Storage
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        extended_content:
          type: array
          items:
            $ref: '#/components/schemas/extended_content'
    Tz:
      title: Time Zone
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        timezone_attributes:
          type: array
          items:
            $ref: '#/components/schemas/timezone_attributes'
    User:
      title: User
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        user_attributes:
          $ref: '#/components/schemas/UserAttributes'
        authorizations:
          type: array
          items:
            $ref: '#/components/schemas/UserAuthorizations'
    UserAttributes:
      type: object
      properties:
        first_name:
          maxLength: 20
          minLength: 0
          type: string
          description: First name of the user.
        last_name:
          maxLength: 20
          minLength: 0
          type: string
          description: Last name of the user.
        is_active:
          type: integer
          description: Indicates whether or not the user is active and can log in
            to the system.
          format: int32
          enum:
          - 0
          - 1
        last_session:
          type: string
          description: Date of the last time the user was logged in.
        show_sys_messages:
          type: integer
          description: Indicates whether or not the user wants to receive system messages.
          format: int32
          enum:
          - 0
          - 1
        modify_objects:
          type: integer
          description: Indicates whether or not the user is allowed to edit and modify
            objects.
          format: int32
          enum:
          - 0
          - 1
        filter:
          maxLength: 255
          minLength: 0
          type: string
          description: Defines the filter that is assigned to the user.
        multi_logons:
          minimum: 0
          type: integer
          description: Defines the number of multiple logons for this user. 0 = infinite
            amount of user logons
          format: int32
        eh_refresh_interval:
          minimum: 0
          type: integer
          description: Minimum refresh interval for the Process Monitoring view.
          format: int32
        valid_from:
          type: string
          description: Defines the start of the time frame the user is allowed to
            log in to the system.
        valid_to:
          type: string
          description: Defines the end of the time frame the user is allowed to log
            in to the system.
        calendar:
          maxLength: 200
          minLength: 0
          type: string
          description: Calendar definition that indicates the days the user is allowed
            to log in.
        calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Calendar event that indicates the days the user is allowed
            to log in.
        home_folder:
          maxLength: 200
          minLength: 0
          type: string
          description: Folder which is permanently mounted to the user.
        privilege:
          type: number
          description: Privileges the user has.
        email1:
          maxLength: 50
          minLength: 0
          type: string
          description: Fist email address of the user.
        email2:
          maxLength: 50
          minLength: 0
          type: string
          description: Second email address of the user.
        is_ldap_user:
          type: integer
          description: Indicates whether or not the user is an LDAP user.
          format: int32
          enum:
          - 0
          - 1
        ldap_uid:
          maxLength: 255
          minLength: 0
          type: string
          description: ID of the LDAP user (objectGUID).
        is_locked:
          type: integer
          description: Indicates whether or not the user is locked.
          format: int32
          enum:
          - 0
          - 1
        distinguished_name:
          maxLength: 1024
          minLength: 0
          type: string
          description: Active Directory distinguishedName for optimized access.
        login:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the login object this user associated with.
        ignore_sso:
          type: integer
          description: Indicates whether or not the user is allowed to ignore Kerberos
            (single sign-on).
          format: int32
          enum:
          - 0
          - 1
        usr_type:
          maxLength: 8
          minLength: 0
          type: string
          description: Defines the type of the user (e.g. AIOPS)
      description: user attributes
    UserAuthorizations:
      type: object
      properties:
        filter_type:
          maxLength: 8
          minLength: 0
          type: string
          description: Filter for type.
        filter_object_type:
          maxLength: 8
          minLength: 0
          type: string
          description: Filter for object type.
        filter_object_name:
          maxLength: 255
          minLength: 0
          type: string
          description: Filter for object name.
        filter_agent_name1:
          maxLength: 200
          minLength: 0
          type: string
          description: "Filter for agent name (e.g. job, event, ft send)."
        filter_agent_name2:
          maxLength: 200
          minLength: 0
          type: string
          description: Filter for agent name (e.g. ft receive).
        filter_user_id1:
          maxLength: 200
          minLength: 0
          type: string
          description: "Filter for user (e.g. job, ft send)."
        filter_user_id2:
          maxLength: 200
          minLength: 0
          type: string
          description: Filter for user (e.g. ft receive).
        filter_file_names1:
          maxLength: 255
          minLength: 0
          type: string
          description: Filter for file names (e.g. ft send).
        filter_file_names2:
          maxLength: 255
          minLength: 0
          type: string
          description: Filter for file names (e.g. ft receive).
        bitcode:
          type: integer
          description: "Bit array to determine which authorizations are set (e.g.\
            \ read, write, modify, execute, etc.)"
          format: int32
        auth_group:
          type: integer
          description: Authorization level/group to determine the order of the authorization
            checks. 0 = prohibition
          format: int32
          enum:
          - 0
          - 1
      description: user/group authorizations
    Usrg:
      title: User Group
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        user_group_attributes:
          $ref: '#/components/schemas/user_group_attributes'
        members:
          type: array
          items:
            $ref: '#/components/schemas/members'
        authorizations:
          type: array
          items:
            $ref: '#/components/schemas/UserAuthorizations'
    action_definitions:
      required:
      - action
      type: object
      properties:
        action:
          maxLength: 30
          minLength: 0
          type: string
          description: Defines the sync action.
        check_status:
          maxLength: 30
          minLength: 0
          type: string
          description: The sync state this rule is valid for.
        check_operator:
          type: string
          description: The comparison operator for the check.
          enum:
          - '< '
          - <=
          - '= '
          - '>='
          - '> '
          - <>
        check_value:
          type: integer
          description: The value to compare with.
          format: int32
        set_status:
          maxLength: 30
          minLength: 0
          type: string
          description: The sync state to be set after the application of the rule.
        set_operator:
          type: string
          description: The operator to apply.
          enum:
          - '+ '
          - '- '
          - '= '
          - '  '
        set_value:
          type: integer
          description: The value to use.
          format: int32
      description: sync rules
    agent_authorization_filters:
      type: object
      properties:
        host:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the agent.
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Platform the agent runs on.
        version:
          maxLength: 12
          minLength: 0
          type: string
          description: Version of the agent.
        hardware:
          maxLength: 32
          minLength: 0
          type: string
          description: Hardware of the host.
        software:
          maxLength: 32
          minLength: 0
          type: string
          description: Software of the host.
        software_version:
          maxLength: 32
          minLength: 0
          type: string
          description: Version of the software.
        roles:
          maxLength: 256
          minLength: 0
          type: string
          description: Role of the agent (from the ini file or directly taken from
            the agent object)
        tcpip_address:
          maxLength: 64
          minLength: 0
          type: string
          description: TCP/IP address
        license_category:
          maxLength: 32
          minLength: 0
          type: string
          description: License category
        is_excluded:
          type: integer
          description: Indicates whether to include or exclude this row.
          format: int32
          enum:
          - 0
          - 1
      description: Filter definitions for agent authorizations
    agent_authorizations:
      required:
      - client
      type: object
      properties:
        client:
          maximum: 9999
          minimum: 0
          type: integer
          description: The client for which this agent authorizations are valid for.
          format: int32
        read:
          type: integer
          description: Determines whether read authorizations are set or not.
          format: int32
          enum:
          - 0
          - 1
        write:
          type: integer
          description: Determines whether write authorizations are set or not.
          format: int32
          enum:
          - 0
          - 1
        execute:
          type: integer
          description: Determines whether execute authorizations are set or not.
          format: int32
          enum:
          - 0
          - 1
      description: agent authorizations
    agent_group_attributes:
      required:
      - mode
      - platform
      type: object
      properties:
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Platform the selected agents run on.
        mode:
          type: string
          description: "Mode of the agent group. A = any, F = first, N = next, L =\
            \ load dependent, X = all"
          enum:
          - A
          - F
          - "N"
          - L
          - X
        max_parallel:
          maximum: 9999
          minimum: -1
          type: integer
          description: Tasks that are allowed to be parallel in mode X (all)
          format: int32
        enforce_on_inactive:
          type: integer
          description: Indicates whether or not a task can be activated using agents
            that are currently not active in mode X (all).
          format: int32
          enum:
          - 0
          - 1
        ra_solution:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the selected RA solution.
      description: agent group attributes
    agent_group_filters:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: "Type of the filter. H = single agent, F = filter"
          enum:
          - H
          - F
        agent:
          maxLength: 32
          minLength: 0
          type: string
          description: Filter for the name of the agent.
        version:
          maxLength: 270
          minLength: 0
          type: string
          description: Filter for the version of the agent.
        hardware:
          maxLength: 32
          minLength: 0
          type: string
          description: Filter for the hardware of the host.
        software:
          maxLength: 32
          minLength: 0
          type: string
          description: Filter for the software of the host.
        software_version:
          maxLength: 32
          minLength: 0
          type: string
          description: Filter for the version of the software.
        archive_key1:
          maxLength: 60
          minLength: 0
          type: string
          description: "Filter for the archive key #1"
        archive_key2:
          maxLength: 20
          minLength: 0
          type: string
          description: "Filter for the archive key #2"
        role:
          maxLength: 256
          minLength: 0
          type: string
          description: Filter for the role of the agent.
      description: Filter table for host group
    array_elements:
      required:
      - element
      - line_number
      type: object
      properties:
        element:
          maxLength: 32
          minLength: 0
          type: string
          description: Variable name of the prompt set element.
        line_number:
          minimum: 1
          type: integer
          description: Sequenced number for the prompt set array elements.
          format: int32
        value:
          type: string
          description: Value of the prompt set array element.
      description: Prompt Set Element Defaults on Array
    authorizations:
      required:
      - client
      type: object
      properties:
        client:
          maximum: 9999
          minimum: 0
          type: integer
          description: Client for which this authorizations are for.
          format: int32
        use:
          type: integer
          description: Has authorization to use.
          format: int32
          enum:
          - 0
          - 1
        read:
          type: integer
          description: Has authorization to read.
          format: int32
          enum:
          - 0
          - 1
        write:
          type: integer
          description: Has authorization to write.
          format: int32
          enum:
          - 0
          - 1
        execute:
          type: integer
          description: Has authorization to execute.
          format: int32
          enum:
          - 0
          - 1
      description: client allocation
    backend_tabs:
      required:
      - name
      - platform
      type: object
      properties:
        name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the tab.
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Platform within the tab.
      description: Object variable tabs
    beneficiaries:
      required:
      - custom_attribute_name
      - custom_attribute_value
      type: object
      properties:
        custom_attribute_name:
          maxLength: 32
          minLength: 0
          type: string
          description: Custom attribute name from UC_CUSTOM_ATTRIBUTES.
        custom_attribute_value:
          maxLength: 200
          minLength: 0
          type: string
          description: Defined custom attribute value from dedicated variable object.
      description: Beneficiaries
    bind_parameters:
      type: object
      properties:
        value:
          type: string
          description: Value of the bind parameter.
        datatype:
          maxLength: 2
          minLength: 0
          type: string
          description: Data type of the bind parameter (EXEC only).
        variable:
          maxLength: 32
          minLength: 0
          type: string
          description: Variable name of the bind parameter (EXEC only).
      description: Object Variable Binding Parameters
    cale:
      title: Calendar
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        events:
          type: array
          items:
            $ref: '#/components/schemas/events'
        calendar_definitions:
          type: array
          items:
            $ref: '#/components/schemas/calendar_definitions'
        group_definitions:
          type: array
          items:
            $ref: '#/components/schemas/group_definitions'
        collision_definitions:
          type: array
          items:
            $ref: '#/components/schemas/collision_definitions'
    calendar_conditions:
      required:
      - calendar
      - calendar_event
      - workflow_line_number
      type: object
      properties:
        workflow_line_number:
          minimum: 1
          type: integer
          description: Sequenced number. Line number within the workflow/schedule.
          format: int32
        calendar:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar.
        calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar event.
      description: Workflow/Schedule calendar condition
    calendar_definitions:
      required:
      - content
      - event_line_number
      - year
      type: object
      properties:
        event_line_number:
          minimum: 1
          type: integer
          description: Sequenced number for the calendar events.
          format: int32
        year:
          minimum: 0
          type: integer
          description: Year
          format: int32
        content:
          maxLength: 372
          minLength: 0
          type: string
          description: "One Byte per day and year. Fixed column width per month (31\
            \ digits x 12). Trailing blanks are truncated. 0 or <blank> = unselected,\
            \ 1 = selected."
      description: Calendar Definitions (Days)
    calendars:
      required:
      - calendar
      - calendar_event
      type: object
      properties:
        calendar:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar.
        calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar event.
      description: Calendar definition for PERIOD objects
    call:
      title: Notification
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        notification_content:
          type: array
          items:
            $ref: '#/components/schemas/notification_content'
        notification_attributes:
          $ref: '#/components/schemas/notification_attributes'
        scripts:
          $ref: '#/components/schemas/ScriptsProcessOnly'
    code:
      title: Code Table
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        code_table:
          $ref: '#/components/schemas/code_table'
    code_table:
      type: object
      properties:
        content:
          maxLength: 1024
          minLength: 0
          type: string
          description: Content of the code table. Base64 encoded.
      description: code table
    collision_definitions:
      required:
      - event
      - event_line_number
      - name
      type: object
      properties:
        event_line_number:
          minimum: 1
          type: integer
          description: Sequenced number for calendar events.
          format: int32
        name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the collision calendar.
        event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the collision calendar event.
        operator:
          type: string
          description: "Operator for ROLL calendars. + = shift forward, - = shift\
            \ backward"
          enum:
          - +
          - "-"
          - S
        offset:
          minimum: 0
          type: integer
          description: Offset by working days.
          format: int32
        reference_calendar:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the reference calendar object.
        reference_calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the referenced calendar event.
      description: The collision definitions for a roll calendar.
    commands:
      required:
      - backend_tab_number
      type: object
      properties:
        backend_tab_number:
          minimum: 1
          type: integer
          description: Line number of the tab.
          format: int32
        operating_system:
          maxLength: 200
          minLength: 0
          type: string
          description: Defines the operating system.
        version:
          maxLength: 32
          minLength: 0
          type: string
          description: Defines the version of the operating system.
        command:
          maxLength: 1024
          minLength: 0
          type: string
          description: Defines the command that will be executed on the operating
            system.
        column_descriptions:
          maxLength: 1024
          minLength: 0
          type: string
          description: Column descriptions of the result.
      description: Object variable commands
    condition_parameters:
      required:
      - condition_line_number
      - condition_variable_name
      - execution_time
      - prompt_set_variable
      - workflow_line_number
      type: object
      properties:
        workflow_line_number:
          minimum: 1
          type: integer
          description: Sequenced number of the workflow tasks.
          format: int32
        execution_time:
          type: integer
          description: "Execution time of the condition/action. 1 = pre condition,\
            \ 2 = post condition, 3 if workflow"
          format: int32
          enum:
          - 1
          - 2
          - 3
        condition_line_number:
          minimum: 1
          type: integer
          description: Sequenced number of parameters within the condition/action.
          format: int32
        condition_variable_name:
          maxLength: 32
          minLength: 0
          type: string
          description: Variable name (S = Parameter set).
        prompt_set_variable:
          maxLength: 32
          minLength: 0
          type: string
          description: Variable name of the refereneced prompt set.
        value:
          type: string
          description: Variable value.
        alternative_view:
          type: integer
          description: Flag for alternative view.
          format: int32
          enum:
          - 0
          - 1
      description: Conditions/Actions ParameterSet
    condition_values:
      required:
      - condition_link_line_number
      - execution_time
      - variable
      - workflow_line_number
      type: object
      properties:
        workflow_line_number:
          minimum: 1
          type: integer
          description: Sequenced number for condition values.
          format: int32
        execution_time:
          type: integer
          description: "Execution time of the condition/action. 1 = pre condition,\
            \ 2 = post condition, 3 if workflow"
          format: int32
          enum:
          - 1
          - 2
          - 3
        condition_link_line_number:
          minimum: 1
          type: integer
          description: Sequenced number of conditions within the workflow task
          format: int32
        variable:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the variable.
        value:
          type: string
          description: Value of the variable.
        type:
          type: string
          description: "Type. V = value, S = parameter set"
          enum:
          - V
          - S
        alternative_view:
          type: integer
          description: Indicates whether the alternative view is enabled or not.
          format: int32
          enum:
          - 0
          - 1
      description: Conditions/Actions Values
    conditions:
      type: object
      properties:
        workflow_line_number:
          minimum: 1
          type: integer
          description: Sequenced number of the workflow tasks.
          format: int32
        execution_time:
          type: integer
          description: "Execution time of the condition/action. 1 = pre condition,\
            \ 2 = post condition, 3 if workflow"
          format: int32
          enum:
          - 1
          - 2
          - 3
        name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the condition/action.
        type:
          maxLength: 1
          minLength: 0
          type: string
          description: "Indicates the type of this entry. C = condition, A = action,\
            \ E = else, F = end if"
          enum:
          - C
          - A
          - E
          - F
        active:
          type: integer
          description: Entry is active or not.
          format: int32
          enum:
          - 0
          - 1
        occurrence:
          type: integer
          description: "Indicates when to check the condition. 0 = every time, 1 =\
            \ once"
          format: int32
          enum:
          - 0
          - 1
        ui_info:
          type: string
          description: User field for UI.
      description: Conditions/Actions Link
    connection_attributes:
      required:
      - platform
      type: object
      properties:
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Host platform.
        job_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Type of the job object (RA only).
        sub_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Sub-type of the object. (RA only).
        reference_timestamp:
          type: string
          description: Reference timestamp of the RA component. Information only.
            (RA only)
      description: Connection object attributes
    custom_attributes:
      required:
      - name
      - value
      type: object
      properties:
        name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the custom attribute.
        value:
          maxLength: 200
          minLength: 0
          type: string
          description: Value of the custom attribute.
      description: Custom Attributes
    documentation:
      type: object
      properties:
        empty:
          type: boolean
      additionalProperties:
        type: array
        description: Contains text and XML documentation. The name of the properties
          depend on the defined values in UC_OBJECT_DOCU. The @ sign in XML docu names
          is replaced by an underscore.
        items:
          type: string
          description: Contains text and XML documentation. The name of the properties
            depend on the defined values in UC_OBJECT_DOCU. The @ sign in XML docu
            names is replaced by an underscore.
      description: Contains text and XML documentation. The name of the properties
        depend on the defined values in UC_OBJECT_DOCU. The @ sign in XML docu names
        is replaced by an underscore.
    elements:
      required:
      - line_number
      - name
      type: object
      properties:
        name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the prompt set element.
        line_number:
          minimum: 1
          type: integer
          description: Sequenced number for the prompt set array elements.
          format: int32
        reference:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the reference object.
        reference_type:
          maxLength: 8
          minLength: 0
          type: string
          description: Type of the reference object.
        reference_key:
          maxLength: 200
          minLength: 0
          type: string
          description: Key of the reference.
        has_list:
          type: integer
          description: Indicates whether or not this element is a list.
          format: int32
          enum:
          - 0
          - 1
        value:
          type: string
          description: The textual representation of the value.
        output_format:
          maxLength: 32
          minLength: 0
          type: string
          description: The output format of the value at time of acces.
        min_value:
          maxLength: 64
          minLength: 0
          type: string
          description: Min. value allowed.
        max_value:
          maxLength: 64
          minLength: 0
          type: string
          description: Max. value allowed.
        to_uppercase:
          type: integer
          description: Indicates whether or not the text value is converted to upper
            case.
          format: int32
          enum:
          - 0
          - 1
        is_required:
          type: integer
          description: Indicates whether or not this element is required and needs
            to be set.
          format: int32
          enum:
          - 0
          - 1
        show_as_password:
          type: integer
          description: Indicates whether or not this element is a password field.
          format: int32
          enum:
          - 0
          - 1
        allow_multiselect:
          type: integer
          description: Indicates whether or not multi-select is allowed for this element.
          format: int32
          enum:
          - 0
          - 1
        separator:
          maxLength: 1
          minLength: 0
          type: string
          description: Defines the separator in case the element contains of multiple
            values.
        quotes:
          maxLength: 1
          minLength: 0
          type: string
          description: Defines the character used for quotes.
        input_assistent:
          type: integer
          description: Indicates whether an input assistent is enabled or not.
          format: int32
          enum:
          - 0
          - 1
        ui_type:
          maxLength: 255
          minLength: 0
          type: string
          description: Defines the type of the ui component.
        alternative_view:
          type: integer
          description: Flag for alternative view.
          format: int32
          enum:
          - 0
          - 1
        custom:
          maxLength: 255
          minLength: 0
          type: string
          description: Value of the custom field of this entry.
        xui:
          type: array
          items:
            type: string
            description: Line of the XML description for the prompt set element.
        key:
          maxLength: 200
          minLength: 0
          type: string
          description: Used for XML variables and contains the key of the variable
            object. (OVW_VValue)
        xpath:
          maxLength: 1024
          minLength: 0
          type: string
          description: XPath expression for XML variables
      description: Prompt Set Element
    event_attributes:
      required:
      - repeat_type
      - type
      type: object
      properties:
        type:
          type: string
          description: "Event type. TT = time event (timer), TS = time event (time\
            \ of execution) FS = file system event, FT = file system event, FA = automatic\
            \ file system event CN = console event, RN = rule event, ON = collector\
            \ event, WN = webhook event"
          enum:
          - TT
          - TS
          - FS
          - FT
          - FA
          - CN
          - RN
          - "ON"
          - DT
          - WN
        repeat_type:
          type: string
          description: "Repeat type of the event. R = check repeatedly, S = single\
            \ check, F = check until first hit"
          enum:
          - R
          - S
          - F
        timeout:
          maxLength: 6
          minLength: 0
          type: string
          description: "The time the event automatically ends. Format: TTHHMM"
        timeout_seconds:
          minimum: 0
          type: integer
          description: The duration (in seconds) the event automatically ends.
          format: int32
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the event.
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
        execution_type:
          type: string
          description: "TS: start after a certain time, E=execute N=no execute, TT\
            \ S=start immediately"
          enum:
          - E
          - "N"
          - S
        time_period:
          maxLength: 4
          minLength: 0
          type: string
          description: Period in minutes or HHMM (depending on the event type).
        sub_type:
          type: string
          description: "Sub-type of the event. (e.g.: filesize, freespace, EY, EC,\
            \ EA event system, event security, event application, O4 = OS/400 Console\
            \ O3 = OS/390, A1 = OPENOUTPUT, A2 = CLOSEOUTPUT, A3 = ALLOUTPUT, S1 =\
            \ SAP Events"
          enum:
          - EY
          - EC
          - EA
          - O4
          - O3
          - A1
          - A2
          - A3
          - S1
          - PC
          - PU
          - FF
          - FZ
        destination_agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the destination agent the event will run on.
        destination_login:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the login object the event will use.
        path:
          maxLength: 255
          minLength: 0
          type: string
          description: The path to check.
        operator:
          type: string
          description: "Defines the operator used for the comparison. G = greater,\
            \ L = less, E = equal, N = not equal, F=greater equal, K=less equal"
          enum:
          - G
          - L
          - E
          - "N"
          - F
          - K
        check_value:
          type: integer
          description: The value to compare with.
          format: int32
        unit:
          type: integer
          description: "Unit of the value. 0 = host-specific, 1 = byte, 2 = KB, 3\
            \ = MB, 4 = GB, 5 =TB"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
        script_type:
          type: integer
          description: Process event script when check failed or timeout occurred.
            1 = false 2 = timeout
          format: int32
          enum:
          - 1
          - 2
        source:
          maxLength: 32
          minLength: 0
          type: string
          description: "Windows event: Source, OS/400: Message type"
        category:
          maximum: 99
          minimum: 0
          type: integer
          description: "Windows event: category, OS/400: severity"
          format: int32
        period_time_zone:
          maxLength: 8
          minLength: 0
          type: string
          description: Time zone for time period when HHMM is used
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Platform type of the agent.
        sub_type2:
          type: string
          description: "Second check type. FC = File changed, FS = File stable"
          enum:
          - FC
          - FS
        check_within:
          type: integer
          description: Defines how long (in seconds) the event checks back in time.
          format: int32
        include_sub_directories:
          type: integer
          description: Indicates whether or not the file event check includes sub-directores.
          format: int32
          enum:
          - 0
          - 1
        consider_all:
          type: integer
          description: Indicates whether the file event considers all files or not.
          format: int32
          enum:
          - 0
          - 1
        operand1_type:
          maxLength: 6
          minLength: 0
          type: string
          description: "Type of first sql query (SQL, VARA, STATIC)"
        operand1_sql:
          maxLength: 4096
          minLength: 0
          type: string
          description: SQL query
        operand1_host:
          maxLength: 200
          minLength: 0
          type: string
          description: Host name of the database server.
        operand1_login:
          maxLength: 200
          minLength: 0
          type: string
          description: Login object used for the database server.
        operand1_server:
          maxLength: 200
          minLength: 0
          type: string
          description: Server name of the database.
        operand1_database:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the database.
        operand1_variable_object:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the VARA object.
        operand1_key:
          maxLength: 200
          minLength: 0
          type: string
          description: Key within the VARA object.
        operand1_value:
          maxLength: 255
          minLength: 0
          type: string
          description: Static expression.
        operand2_type:
          maxLength: 6
          minLength: 0
          type: string
          description: "Type of second sql query (SQL, VARA, STATIC)"
        operand2_sql:
          maxLength: 4096
          minLength: 0
          type: string
          description: SQL query
        operand2_host:
          maxLength: 200
          minLength: 0
          type: string
          description: Host name of the database server.
        operand2_login:
          maxLength: 200
          minLength: 0
          type: string
          description: Login object used for the database server.
        operand2_server:
          maxLength: 200
          minLength: 0
          type: string
          description: Server name of the database.
        operand2_database:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the database.
        operand2_variable_object:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the VARA object.
        operand2_key:
          maxLength: 200
          minLength: 0
          type: string
          description: Key within the VARA object.
        operand2_value:
          maxLength: 255
          minLength: 0
          type: string
          description: Static expression.
        store_object:
          maxLength: 200
          minLength: 0
          type: string
          description: Identification of STORE object (EVNT.IA.* only).
      description: event attributes
    event_filters:
      type: object
      properties:
        code:
          maxLength: 8
          minLength: 0
          type: string
          description: ID of the filter or filter for 'Activation State' (XI Adapter
            Monitoring)
        filter:
          maxLength: 255
          minLength: 0
          type: string
          description: SAP event parameter or filter for 'Channel Name' (XI Adapter
            Monitoring)
        event_id:
          minimum: 0
          type: integer
          description: Event ID (Windows event)
          format: int32
        event_type:
          type: integer
          description: "Event type (Windows event): 1 = error, 2 = warning, 4 = information,\
            \ 8 = success audit, 16 = failure audit"
          format: int32
          enum:
          - 1
          - 2
          - 4
          - 8
          - 16
        user_id:
          maxLength: 32
          minLength: 0
          type: string
          description: "User (Windows event), Message ID (OS/400), Event ID (SAP),\
            \ XI Adapter Monitoring: filter for 'State'"
        sap_event_server:
          maxLength: 40
          minLength: 0
          type: string
          description: "SAP Event: batch server name"
        service:
          maxLength: 255
          minLength: 0
          type: string
          description: filter for 'Service' (XI Adapter Monitoring)
        party:
          maxLength: 255
          minLength: 0
          type: string
          description: filter for 'Party' (XI Adapter Monitoring)
      description: event content (filter)
    events:
      required:
      - calendar_event
      type: object
      properties:
        calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar event.
        calendar_type:
          type: string
          description: "Type of the calendar event. Y = yearly, M = monthly, W = weekly,\
            \ S = static, R = roll, G = group, O = old-fashioned calendar event"
          enum:
          - "Y"
          - M
          - W
          - S
          - R
          - G
          - O
        sub_type:
          type: string
          description: "Sub-type of the calendar event. A = absolute, R = relative,\
            \ I = interval, ' ' = none (used for ROLL or Group)"
          enum:
          - A
          - R
          - I
          - ' '
        valid_from:
          type: string
          description: The timestamp the calendar event is valid from.
        valid_to:
          type: string
          description: The timestamp the calendar event is valid until.
        public_holiday_number:
          minimum: 0
          type: integer
          description: Message number for national holiday calendars.
          format: int32
        period:
          minimum: 0
          type: integer
          description: Defines the period (every n).
          format: int32
        period_start:
          minimum: 0
          type: integer
          description: Defines the start of the period (e.g. month 02).
          format: int32
        period_end:
          minimum: 0
          type: integer
          description: Defines the end of the period (e.g. month 02).
          format: int32
        defined_days:
          maxLength: 2600
          minLength: 0
          type: string
          description: Defined days (24.12;31.12;) or (1;3;12) or (SU;MO;WE)
        interval:
          minimum: 0
          type: integer
          description: Defines the interval (every n days)
          format: int32
        direction:
          type: string
          description: "The direction. B = begin, E = end"
          enum:
          - B
          - E
        interval_start:
          maxLength: 4
          minLength: 0
          type: string
          description: "Start of the interval. Formats: DDMM or DD"
        interval_end:
          maxLength: 4
          minLength: 0
          type: string
          description: "End of the interval. Formats: DDMM or DD"
        role_calendar_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar (basis for ROLL calendar)
        role_calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar event (basis for ROLL calendar)
        role_calendar_adjust:
          minimum: 0
          type: integer
          description: Adjustment in days.
          format: int32
        role_calendar_adjust_operator:
          type: string
          description: "Operator for ROLL calendars. + = shift forward, - = shift\
            \ backward"
          enum:
          - +
          - "-"
        role_calendar_offset:
          minimum: 0
          type: integer
          description: days for ROLL calendars. 0 = adjust to next workingday according
            to operator; >0 = adjust to next workingday according to operator plus
            offset of working days
          format: int32
        role_calendar_has_reference:
          type: integer
          description: Indicates that a calendar is used for reference.
          format: int32
          enum:
          - 0
          - 1
        reference_calendar:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the referred calendar object.
        reference_calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the referred calendar event.
      description: Calendar events
    evnt:
      title: Event
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        event_filters:
          type: array
          items:
            $ref: '#/components/schemas/event_filters'
        validation_period:
          type: array
          items:
            $ref: '#/components/schemas/validation_period'
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/ScriptsOfEvent'
        event_attributes:
          $ref: '#/components/schemas/event_attributes'
        extended_values:
          type: array
          items:
            $ref: '#/components/schemas/extended_values'
    extended_content:
      required:
      - component
      - hardware
      - platform
      - software
      type: object
      properties:
        component:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the content.
        type:
          type: integer
          format: int32
          writeOnly: true
        content:
          type: string
          description: Base64 encoded content
        modification_date:
          type: string
          description: Modification timestamp of the resource within the object.
        file_name:
          maxLength: 512
          minLength: 0
          type: string
          description: Defines the file name the resource will have on the target
            file system.
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Restrict the resource to a particular operating systems.
        software:
          maxLength: 32
          minLength: 0
          type: string
          description: Restrict the resource to a particular software.
        usage:
          type: string
          description: "Defines whether or not this resource has to be stored in the\
            \ client or task cache. T = Task, C = Client"
          enum:
          - T
          - C
        replace_variables:
          type: integer
          description: Replace variables in this resource. Textual content only.
          format: int32
        file_type:
          type: string
          description: "The data representation type used for data transfer and storage.\
            \ T = Text, B = Binary"
          enum:
          - T
          - B
        checksum:
          maxLength: 512
          minLength: 0
          type: string
          description: Checksum of the content.
        version:
          maxLength: 512
          minLength: 0
          type: string
          description: Version of the content.
        hardware:
          maxLength: 32
          minLength: 0
          type: string
          description: Restrict the resource to a particular hardware.
      description: binary data
    extended_task_values:
      required:
      - type
      - value_name
      - workflow_line_number
      type: object
      properties:
        workflow_line_number:
          minimum: 1
          type: integer
          description: Sequenced number of the workflow tasks.
          format: int32
        value_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the value.
        type:
          type: integer
          description: "Parameter type of the task. SAP: 0 = jxpb job parameter, 1\
            \ = http connection, 2 = rfc connection, DB: 1 = db connection parameter,\
            \ RA: 2 = job panel, 3 = general panel, 4 = connection panel, 5 = agent\
            \ panel, 6 = others panel, 7 = pushed values"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
        encrypted:
          type: integer
          description: "Indicates whether the value is encrypted or not. 0 = not encrypted,\
            \ 1 = encryption type 1 (deprecated), 2 = encryption type 2 (new)"
          format: int32
          enum:
          - 0
          - 1
          - 2
        is_connection:
          type: integer
          description: Indicates whether or not the value is a connection value.
          format: int32
          enum:
          - 0
          - 1
        value:
          type: string
          description: Value.
      description: RA Value Usage in Process Flow Task
    extended_values:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the value.
        type:
          type: integer
          description: "Parameter type of the object. SAP: 0 = jxpb job parameter,\
            \ 1 = http connection, 2 = rfc connection, DB: 1 = db connection parameter,\
            \ RA: 2 = job panel, 3 = general panel, 4 = connection panel, 5 = agent\
            \ panel, 6 = others panel, 7 = pushed values"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          default: 0
        encrypted:
          type: integer
          description: "Indicates whether the value is encrypted or not. 0 = not encrypted,\
            \ 1 = encryption type 1 (deprecated), 2 = encryption type 2 (new)"
          format: int32
          enum:
          - 0
          - 1
          - 2
          default: 0
        is_connection:
          type: integer
          description: Indicates whether or not the value is a connection object name.
          format: int32
          enum:
          - 0
          - 1
          default: 0
        value:
          type: string
          description: The value.
      description: "Values of RA objects, CONN and SAP JXBP Jobs."
    external_output_files:
      required:
      - file_full_path
      type: object
      properties:
        file_full_path:
          maxLength: 512
          minLength: 0
          type: string
          description: Full path of the external output file.
        require_login:
          type: integer
          description: Flag indicates that user login is required or not.
          format: int32
          enum:
          - 0
          - 1
      description: Object External Output
    file_transfer_attributes:
      type: object
      properties:
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the file transfer.
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        attribute_dialog:
          type: integer
          description: "Indicates, whether or not that the attribute dialog is opened\
            \ when the object is started."
          format: int32
          enum:
          - 0
          - 1
        destination_agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the destination agent.
        destination_login:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the login object used on the destination host.
        destination_code_table:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the code table used on the destination host.
        destination_path:
          maxLength: 512
          minLength: 0
          type: string
          description: File path on the destination host.
        source_agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the source agent.
        source_login:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the login object used on the source host.
        source_code_table:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the code table used on the source host.
        source_path:
          maxLength: 512
          minLength: 0
          type: string
          description: File path on the source host.
        text_type:
          type: string
          description: "Type of the data that is transferred. '1' = binary, '0' =\
            \ text"
          enum:
          - "0"
          - "1"
        allow_overwrite:
          type: string
          description: "Indicates, that existing files are overwritten on the destination\
            \ host.'0' = cancel transfer, '1' = overrwrite, '2' = append"
          enum:
          - "0"
          - "1"
          - "2"
        erase_source_files:
          type: integer
          description: "Indicates, that transferred files are deleted on the source\
            \ host."
          format: int32
          enum:
          - 0
          - 1
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
        max_parallel_ft:
          maximum: 99999
          minimum: 0
          type: integer
          description: Maximum number of parallel running file transfers when using
            wildcard characters.
          format: int32
        repeat_type:
          type: string
          description: "File transfer using wildcard characters: include subdirectories.\
            \ R = yes, S = no"
          enum:
          - R
          - S
        use_wild_cards:
          type: integer
          description: "Indicates, that this file transfer uses wild cards. 0 = no,\
            \ 1 = yes"
          format: int32
          enum:
          - 0
          - 1
        additional_attributes:
          maxLength: 1024
          minLength: 0
          type: string
          description: Additional attributes
        compress:
          maxLength: 1
          minLength: 0
          type: string
          description: "Compress level. 0 = no compression, 1 = compression, null\
            \ = default"
        resources_needed:
          type: integer
          description: Resources needed by this file transfer. 0 = value from UC_SYSTEM_SETTINGS
          format: int32
        keep_attributes:
          type: integer
          description: "Keep file attributes on source host (only on the same operating\
            \ system possible). 0 = no, 1 = yes"
          format: int32
          enum:
          - 0
          - 1
        cancel_on_first_error:
          type: integer
          description: "Defines, if a file transfer shall be cancelled, when an error\
            \ occurs during a wildcard file transfer. 0 = no, 1 = yes"
          format: int32
          enum:
          - 0
          - 1
        include_sub_directories:
          type: integer
          description: "Indicates, that the complete sub-folder structure (incl. files)\
            \ shall be transferred or not. 0 = no, 1 = yes"
          format: int32
          enum:
          - 0
          - 1
      description: file transfer attributes
    filter:
      title: Filter
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        filter_attributes:
          $ref: '#/components/schemas/filter_attributes'
        filter_definitions:
          type: array
          items:
            $ref: '#/components/schemas/filter_definitions'
    filter_attributes:
      required:
      - filter_type
      - operator
      type: object
      properties:
        operator:
          type: string
          description: "Indicates whether all filter conditions need to match or just\
            \ at least one. A = and, O = or"
          enum:
          - A
          - O
        filter_type:
          type: string
          description: Type of the filter.
          enum:
          - OUTPUT
      description: Object Filter Attributes
    filter_definitions:
      required:
      - contains
      - filter_text
      - source_name
      - source_type
      type: object
      properties:
        source_type:
          type: string
          description: "Source type of this filter. R = Report, F = File, O = Registered\
            \ Job Output"
          enum:
          - R
          - F
          - O
        contains:
          type: string
          description: "Filter condition for this line. C = contains, N = does not\
            \ contain"
          enum:
          - C
          - "N"
        source_name:
          maxLength: 255
          minLength: 0
          type: string
          description: "Source of the filter. Report type (e.g. ACT, LOG, REP) or\
            \ file name."
        filter_text:
          maxLength: 255
          minLength: 0
          type: string
          description: Filter text for this filter line.
      description: Object Filter Content
    fold:
      type: object
      properties:
        fold:
          title: Folder
          required:
          - generalAttributes
          type: object
          properties:
            metadata:
              $ref: '#/components/schemas/metadata'
            generalAttributes:
              $ref: '#/components/schemas/FolderGeneralAttributes'
    folder:
      title: Folder content
      required:
      - data
      - path
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ApiDocFolderContent'
        path:
          type: string
          description: Object path
      description: Contains the AEObject/Link/Sub folder and relative path.
    foreach_definitions:
      required:
      - source_type
      type: object
      properties:
        source_type:
          type: integer
          description: "Source for the iteration variable. 1 = VARA, 2 = Array"
          format: int32
          enum:
          - 1
          - 2
        source:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the iteration variable.
        vara_column:
          type: integer
          description: Column used within the VARA.
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
        publish_as:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the published script variable the iteration value is
            stored.
      description: ForEach in Workflow
    general_attributes:
      required:
      - name
      - type
      type: object
      properties:
        type:
          maxLength: 8
          minLength: 0
          type: string
          description: Type of the object.
        name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the object.
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Description of the object.
        modified_by:
          maxLength: 200
          minLength: 0
          type: string
          description: ID of the user who modified the object last.
        modified:
          type: string
          description: Date of the object's last modification.
        created_by:
          maxLength: 200
          minLength: 0
          type: string
          description: ID of the user who created the object.
        created:
          type: string
          description: Creation date of the object.
        workflow_children:
          minimum: 0
          type: integer
          description: Number of children a schedule/workflow contains.
          format: int32
        is_shared:
          type: string
          description: "Indicates whether a client 0 object is visible in other clients.\
            \ N = Do not share, L = share read only, R = referenceable"
          enum:
          - L
          - "N"
          - R
        client0_object_id:
          minimum: 0
          type: integer
          description: Indicates a reference to a client 0 object.
          format: int32
        extended_reports:
          type: integer
          description: "Status of extended reports to be written. 0 = Default (UC_CLIENT_SETTINGS),\
            \ 1 = ALL, 2 = None"
          format: int32
          enum:
          - 0
          - 1
          - 2
        max_wait_time:
          minimum: 0
          type: integer
          description: Number of seconds to wait before starting the object.
          format: int32
        max_parallel:
          minimum: 0
          type: integer
          description: Maximum number of parallel running tasks.
          format: int32
        max_parallel_action:
          type: integer
          description: "Defines how the task proceeds in case the maximum number of\
            \ parallel running tasks allowed has reached. 0 = not defined, 1 = wait\
            \ for next slot, 2 = abort task"
          format: int32
          enum:
          - 0
          - 1
          - 2
        archive_key1:
          maxLength: 60
          minLength: 0
          type: string
          description: "Archive key #1"
        archive_key2:
          maxLength: 20
          minLength: 0
          type: string
          description: "Archive key #2"
        max_allowed_retcode:
          type: integer
          description: Up to this return code the tasks will end successfully (status
            = ENDED_OK).
          format: int32
        mrt_method:
          type: integer
          description: "Method for calculating the maximum runtime of the object.\
            \ 0 = no audit, 1 = fix in seconds, 2 = fix time, 4 = ERT + xx%, 256 =\
            \ Cancel, 512 = Start Object, 65536 = SRT in seconds, 131072 = SRT ERT\
            \ + xx%"
          format: int32
        mrt:
          minimum: 0
          type: integer
          description: Maximum runtime time in seconds.
          format: int32
        mrt_time:
          maxLength: 6
          minLength: 0
          type: string
          description: Maximum runtime in time format ddhhmm.
        mrt_ert:
          minimum: 0
          type: integer
          description: MRT = ERT + xx%
          format: int32
        mrt_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Object to start for runtime audit.
        frt:
          minimum: 0
          type: integer
          description: Fixed runtime in seconds.
          format: int32
        ert:
          minimum: 0
          type: integer
          description: Estimated runtime (ERT) in seconds.
          format: int32
        ert_check_last_runs:
          type: integer
          description: Check last x runs for ERT.
          format: int32
        ert_correction:
          minimum: 0
          type: integer
          description: Correction for estimated runtime in percentage.
          format: int32
        ert_deviation_extend:
          type: integer
          description: Ignore ERT > xx% deviation
          format: int32
        ert_min_runs:
          minimum: 0
          type: integer
          description: Ignore ERT below a certain number of runs.
          format: int32
        ert_method:
          type: integer
          description: "Method for calculating the estimated runtime of the object.\
            \ 0 = default, 1 = fix, 2 = avg, 4 = max, 8 = line arregression, 16 =\
            \ Adaptive ERT, 256 = ignore deviation"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 4
          - 8
          - 16
          - 256
        ert_trend:
          type: integer
          description: "Trend of the estimated runtime. 0 = undefined, 1=constant\
            \ downward, 2=downward, 4=upward, 8 = constant upward"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 4
          - 8
        srt:
          minimum: 0
          type: integer
          description: Shortest runtime (SRT) in seconds
          format: int32
        srt_ert:
          minimum: 0
          type: integer
          description: SRT = ERT + xx%
          format: int32
        default_forecast_status:
          type: integer
          description: Default end status for forecast.
          format: int32
        priority:
          maximum: 255
          minimum: 0
          type: integer
          description: Priority of the object.
          format: int32
        time_zone:
          maxLength: 8
          minLength: 0
          type: string
          description: Time zone of the object.
        mrt_time_zone:
          maxLength: 8
          minLength: 0
          type: string
          description: Time zone used for max. runtime (when a fixed time is used).
        has_object_variables:
          type: integer
          description: "Indicates whether the object contains object variables or\
            \ not (0 = no object variables, 1 = object variabels available)"
          format: int32
          enum:
          - 0
          - 1
        inherit_object_variables:
          type: integer
          description: "Defines how object variables are passed to the objects children.\
            \ 0 = inherit all, 1 = inherit defined, 2 = inherit none)"
          format: int32
          enum:
          - 0
          - 1
          - 2
        file_scan_agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the agent used for the file scan.
        file_scan_login:
          maxLength: 200
          minLength: 0
          type: string
          description: Login object used for the file scan.
        max_retcode_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Alarm object that is executed if max retcode is reached.
        inherit_output_filter:
          type: string
          description: "Defines where to apply the output filters to. N = parent task\
            \ only, Y = parent and children tasks, C = children tasks only"
          enum:
          - "N"
          - "Y"
          - C
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Platform of the destination agent.
        queue:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the queue the object runs within.
        child_queue:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the queue the children are assigned to.
        has_prompts:
          type: integer
          description: Object has prompt sets defined.
          format: int32
          enum:
          - 0
          - 1
        has_output_filters:
          type: integer
          description: Object has external output files defined.
          format: int32
          enum:
          - 0
          - 1
        child_flags:
          maxLength: 32
          minLength: 0
          type: string
          description: Flags for sub-tables.
        is_template:
          type: integer
          description: Indicates that the object is a template or not.
          format: int32
          enum:
          - 0
          - 1
        icon:
          maxLength: 8
          minLength: 0
          type: string
          description: Icon of the object.
        rollback_enabled:
          type: integer
          description: "Indicates, that rollback functionality is enabled for that\
            \ object."
          format: int32
          enum:
          - 0
          - 1
        is_inactive:
          type: integer
          description: "Indicates, that this object is active or not."
          format: int32
          enum:
          - 0
          - 1
        sub_type:
          maxLength: 8
          minLength: 0
          type: string
          description: The sub-type of the object.
        deactivation_delay:
          minimum: 0
          type: integer
          description: Deactivation delay in minutes.
          format: int32
        auto_deactivation:
          type: string
          description: "Indicates wheter the object is automatically deactivated when\
            \ finished.  A = always, N = no, F = when errorfree, J = during first\
            \ error-free run"
          enum:
          - A
          - "N"
          - F
          - J
        deactivation_condition:
          maxLength: 30
          minLength: 0
          type: string
          description: OK state for automatic deactivation.
        minimum_ae_version:
          maxLength: 8
          minLength: 0
          type: string
          description: The minimum version of the AE system the object can be used
            with.
      description: The header of the object.
    group_attributes:
      type: object
      properties:
        max_parallel:
          maximum: 999
          minimum: 0
          type: integer
          description: Maximum number of parallel running tasks
          format: int32
        start_mode:
          type: integer
          description: "Indicates how the group will be started. 0 = manually started,\
            \ 1 = started with time control"
          format: int32
          enum:
          - 0
          - 1
        start_via_workflow:
          type: integer
          description: Indicates whether it is allowed to start the group through
            a workflow or not.
          format: int32
          enum:
          - 0
          - 1
        start_manually:
          type: integer
          description: Indicates whether it is allowed to start the group manually
            or not.
          format: int32
          enum:
          - 0
          - 1
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
      description: group attributes
    group_definitions:
      required:
      - calendar
      - calendar_event
      - event_line_number
      - line_number
      - operator
      type: object
      properties:
        event_line_number:
          minimum: 1
          type: integer
          description: Sequenced number for the calendar events.
          format: int32
        line_number:
          type: integer
          description: Sequenced number for group calendars.
          format: int32
        operator:
          type: string
          description: "Operator. 1 = or, 2 = and, 3 = not"
          enum:
          - "1"
          - "2"
          - "3"
        calendar:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar.
        calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar event.
      description: Group calendars
    gui_description:
      required:
      - xui
      type: object
      properties:
        xui:
          type: string
          description: "UI description of the prompt set attributes (e.g. caption,\
            \ dimension)"
      description: Prompt Set Attributes
    job_attributes:
      required:
      - agent
      type: object
      properties:
        agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the destination agent or agent group
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the job.
        max_cpu_time:
          type: integer
          description: "BS2000: Maximum CPU time the job is allowed to use."
          format: int32
        login:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the login object used on the destination host.
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        attribute_dialog:
          type: integer
          description: "Indicates, whether or not the attribute dialog is opened when\
            \ the object is started."
          format: int32
          enum:
          - 0
          - 1
        priority:
          maxLength: 5
          minLength: 0
          type: string
          description: Priority of the job.
        express_flag:
          type: integer
          description: "BS2000: Express flag. -1 = enabled. The job is started immediately\
            \ regardless of the batch limit."
          format: int32
          enum:
          - 0
          - -1
          default: 0
        job_report_path:
          maxLength: 8
          minLength: 0
          type: string
          description: Destination of the job reports.
        job_class:
          maxLength: 8
          minLength: 0
          type: string
          description: BS2000 and z/OS Job class.
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
          default: 0
        code_table:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the code table used by the job.
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Attribute type of the host the job runs on.
        resources_needed:
          maximum: 100000
          minimum: 0
          type: integer
          description: Resources needed by this job. 0 = value from UC_SYSTEM_SETTINGS
          format: int32
          default: 0
        ra_type:
          type: integer
          description: "0 = RA Agent Solution, 1 = RA Module Solution"
          format: int32
          enum:
          - 0
          - 1
        type:
          maxLength: 200
          minLength: 0
          type: string
          description: "Name of the RA solution, for example FTPAGENT or WEBSERVICEREST"
        sub_type:
          maxLength: 200
          minLength: 0
          type: string
          description: "Name of the RA job type, for example FTPFILETRANSFERJOB"
        optional_reports:
          maxLength: 64
          minLength: 0
          type: string
          description: List of optional reports the job generates.
        request_parameters:
          type: integer
          description: Indicates that parameters are requestd.
          format: int32
          enum:
          - 0
          - 1
        connection_object:
          maxLength: 200
          minLength: 0
          type: string
          description: "SQL Job: Name of the connection object"
        sap_job_type:
          type: string
          description: "SAP Job type: 0 = ABAP, 1 = PI, 2 = JXBP"
          enum:
          - "0"
          - "1"
          - "2"
        sap_addresstype:
          type: string
          description: "SAP address type:\n<pre>\r\n' ' ... Name\r\n'P' ... Private\
            \ distribution list\r\n'C' ... Shared distribution list\r\n'O' ... SAPoffice\
            \ user\r\n'B' ... SAP user\r\n'U' ... Internet address\r\n'X' ... X.400\
            \ address\r\n'R' ... SAP user in another SAP System\r\n'A' ... External\
            \ address\r\n'F' ... Fax number\r\n'D' ... X.500 Address\r\n'L' ... Telex\
            \ number\r\n'H' ... Organizational unit/position\r\n'J' ... SAP object\r\
            \n'G' ... Organization object/ID\r\n'K' ... Pager/SMS\r\n'9' ... Others\r\
            \n</pre>"
          enum:
          - ' '
          - P
          - C
          - O
          - B
          - U
          - X
          - R
          - A
          - F
          - D
          - L
          - H
          - J
          - G
          - K
          - "9"
        sap_dst_system:
          maxLength: 32
          minLength: 0
          type: string
          description: SAP target system
        sap_job_delete:
          type: string
          description: "SAP: Delete job, 1 = yes, 0 = no"
          enum:
          - "0"
          - "1"
          default: "0"
        sap_deliver:
          type: string
          description: "SAP: report send status:\n<pre>\r\n' ' ... Use default\r\n\
            'A' ... Always\r\n'E' ... Error case\r\n'N' ... Never\r\n</pre>"
          enum:
          - ' '
          - A
          - E
          - "N"
          - "N"
        sap_lang:
          maxLength: 2
          minLength: 0
          type: string
          description: "SAP: Language, can be empty or two-letter code as defined\
            \ by ISO-63, for example EN"
        sap_recipient:
          maxLength: 241
          minLength: 0
          type: string
          description: "SAP: Receiver of a spool list"
        sap_job_del_not_on_error:
          type: string
          description: "SAP: Only delete Job from CCMS if no error occured"
          enum:
          - "0"
          - "1"
          default: "0"
        sap_express:
          type: string
          description: "SAP Spool List Recipient: Express sending"
          enum:
          - "0"
          - "1"
        sap_statusbymail:
          type: string
          description: "SAP: Send report status by mail: \n<pre>\r\n' ' ... Use default\r\
            \n'A' ... Always\r\n'E' ... Error case\r\n'N' ... Never\r\n</pre>"
          enum:
          - ' '
          - A
          - E
          - "N"
          default: ""
        sap_override_login:
          type: string
          description: "SAP: Use login from Job"
          enum:
          - "0"
          - "1"
          default: "0"
        sap_blindcopy:
          type: string
          description: "SAP Spool List Recipient: Blind copy"
          enum:
          - "0"
          - "1"
          default: "0"
        sap_copy:
          type: string
          description: "SAP Spool List Recipient: Copy"
          enum:
          - "0"
          - "1"
          default: "0"
        platform_job_class:
          type: string
          description: SAP Job class
          enum:
          - A
          - B
          - C
          - ' '
        sap_noprint:
          type: string
          description: "SAP Spool List Recipient: No printing"
          enum:
          - "0"
          - "1"
          default: "0"
        sap_noforward:
          type: string
          description: "SAP Spool List Recipient: No Forwarding"
          enum:
          - "0"
          - "1"
          default: "0"
        sap_startmode:
          type: string
          description: "SAP start mode immediately = 1, as soon as possible = 0"
          enum:
          - "0"
          - "1"
          default: "0"
        job_name:
          maxLength: 508
          minLength: 0
          type: string
          description: "Job name used by BS2000,MPE,MVS,OS400,R3,VMS"
        jmx_connection_type:
          type: string
          description: "JMX: Connection to the MBeanServer. JNDI lookup = 1, local\
            \ MBeanServer = 2, Use any = 7, remote = 4"
          enum:
          - "1"
          - "2"
          - "7"
          - "4"
        jmx_create_instance:
          type: string
          description: "JMX: Create local MBeanServer if not found."
          enum:
          - "0"
          - "1"
        jndi:
          maxLength: 22
          minLength: 0
          type: string
          description: "JMX: JNDI lookup name of the MBeanServer"
        server_url:
          type: string
          description: "JMX: URL of the remote MBean Server"
        initial_context_factory:
          type: string
          description: "JMX: Initial context factory"
        agent_id:
          type: string
          description: "JMX: Agent id"
        sql_captions:
          type: string
          description: "SQL: Show headlines in table"
          enum:
          - "0"
          - "1"
          default: "0"
        server_name:
          maxLength: 100
          minLength: 0
          type: string
          description: "SQL: Hostname and port of the database server if no connection\
            \ object is used."
        sql_remove_crlf:
          type: string
          description: "SQL job report: Remove line breaks"
          enum:
          - "0"
          - "1"
          default: "0"
        sql_subst_character:
          maxLength: 1
          minLength: 0
          type: string
          description: "SQL: Substitute Character"
        sql_column_seperator:
          maxLength: 1
          minLength: 0
          type: string
          description: "SQL: Column Separator"
        sql_max_rows:
          type: string
          description: "SQL: Maximum table rows (0 = unlimited)"
          default: "0"
        sql_show_null:
          type: string
          description: "SQL: Show NULL for empty strings"
          enum:
          - "0"
          - "1"
          default: "0"
        sql_max_characters:
          type: string
          description: "SQL: Max. number of characeters for a text column in a result\
            \ set (0 = unlimited)"
        database_name:
          maxLength: 100
          minLength: 0
          type: string
          description: "SQL: Database"
        win_report_by_script:
          type: string
          description: "Windows: Scripted Report"
          enum:
          - "0"
          - "1"
          default: "0"
        win_work_dir:
          maxLength: 255
          minLength: 0
          type: string
          description: "Windows: Working Directory"
        win_view:
          type: string
          description: "Windows: View Job on Desktop: normal=0, minimized=1, maximized=2"
          enum:
          - "0"
          - "1"
          - "2"
        win_logon_as_batch:
          type: string
          description: "Windows: Log on as batch user"
          enum:
          - "0"
          - "1"
          default: "0"
        job_object:
          type: string
          description: "Windows: Use Windows OS Job Object, yes=1, no=0"
          enum:
          - "0"
          - "1"
        win_cmd:
          maxLength: 255
          minLength: 0
          type: string
          description: "Windows: Command"
        win_typ:
          type: string
          description: "Windows: Type, Batch=0, Command=1, Custom Interpreter=2"
          enum:
          - "0"
          - "1"
          - "2"
          default: "0"
        win_show_at_desktop:
          type: string
          description: "Windows: Show Job on desktop."
          enum:
          - "0"
          - "1"
        mvs_schenv:
          maxLength: 16
          minLength: 0
          type: string
          description: "z/OS: Specification of a scheduling environment"
        mvs_account:
          maxLength: 40
          minLength: 0
          type: string
          description: "z/OS: Accounting Information"
        mvs_routemsgclass:
          maxLength: 36
          minLength: 0
          type: string
          description: "z/OS: Message classes which should be routed."
        mvs_getmsgclasses:
          maxLength: 36
          type: string
          description: "z/OS: Message classes which should be read and routed."
        mvs_determine_retcode:
          maxLength: 1
          type: string
          description: "z/OS return code: Highest=H, Latest=L"
          enum:
          - H
          - L
        mvs_jobtype:
          type: string
          description: "z/OS type: Automation Engine=8, OS/390 JCL=9, JCL including\
            \ OS/390 job card=A"
          enum:
          - "8"
          - "9"
          - A
        mvs_notify:
          maxLength: 17
          minLength: 0
          type: string
          description: "z/OS: Notify"
        jcl_source:
          maxLength: 255
          minLength: 0
          type: string
          description: "z/OS: Name of the dataset or member which contains\r\n\t *\
            \ <ul>\r\n\t * <li>the JCL of the Job (Option \"JCL from OS/390\") or\r\
            \n\t * <li>the JCL and the Job card of the Job (Option \"JCL incl. Job\
            \ card from OS/390\").\r\n\t * </ul>"
        mvs_jobpurge:
          type: string
          description: "z/OS: delete after reading=1, do not purge=0, default=2"
          enum:
          - "0"
          - "1"
          - "2"
        mvs_prog_name:
          maxLength: 20
          minLength: 0
          type: string
          description: "z/OS: Program name"
        mvs_job_params:
          maxLength: 255
          minLength: 0
          type: string
          description: "z/OS: Additional job parameters, e.g. \"TIME=1440\".\r\nMultiple\
            \ job parameters are should be separated by commas."
        mvs_msg_level:
          maxLength: 3
          minLength: 0
          type: string
          description: "z/OS: MSGLEVEL"
        mvs_msgclass:
          maxLength: 1
          minLength: 0
          type: string
          description: "z/OS: MSGCLASS"
        mvs_releasemsgclass:
          type: string
          description: "z/OS: Print Release, Agent default=2, release after reading=1,\
            \ do not release=0"
          enum:
          - "0"
          - "1"
          - "2"
        mvs_completejobout:
          type: string
          description: "z/OS Job Log Complexity: Agent default=2, store JES and job\
            \ output=1, store only JES executions=0"
          enum:
          - "0"
          - "1"
          - "2"
        ps_job_delete:
          type: string
          description: "PeopleSoft: Delete job, yes=1, no=0"
          enum:
          - "0"
          - "1"
        oa_appl_name:
          maxLength: 50
          minLength: 0
          type: string
          description: "OA: Application short name"
        oa_resp_name:
          maxLength: 100
          minLength: 0
          type: string
          description: "OA: Responsibility key of the Oracle user"
        os400_jobd:
          maxLength: 21
          minLength: 0
          type: string
          description: "OS/400: Job Description"
        os400_rtgdta:
          maxLength: 255
          minLength: 0
          type: string
          description: "OS/400: Rooting data"
        os400_joblog:
          type: string
          description: "OS/400: Store from Spool, Complete=1, Job log=0"
          enum:
          - "0"
          - "1"
        os400_jobtype:
          type: string
          description: "OS/400 Job type: CMD=5, ILE CL=6, REXX=7"
          enum:
          - "5"
          - "6"
          - "7"
        os400_jobq:
          maxLength: 21
          minLength: 0
          type: string
          description: OS/400 Job Queue
        siebel_servers:
          maxLength: 128
          minLength: 0
          type: string
          description: Siebel Server Name
        language:
          maxLength: 3
          minLength: 0
          type: string
          description: Siebel language
        gateway_server:
          maxLength: 128
          minLength: 0
          type: string
          description: "Siebel: Gateway Server"
        compression:
          type: string
          description: "Siebel: Transfer data compressed"
          enum:
          - "0"
          - "1"
        encryption:
          type: string
          description: "Siebel: Transfer data encrypted"
          enum:
          - "0"
          - "1"
        enterprise_server:
          maxLength: 128
          minLength: 0
          type: string
          description: "Siebel: Enterprise Server Name"
        home_terminal:
          maxLength: 26
          minLength: 0
          type: string
          description: "NSK: Virtual Terminal"
        nsk_job_type:
          type: string
          description: "NSK Job type, TACL=0, NBEXEC=1, OSS=2"
          enum:
          - ""
          - "0"
          - "1"
          - "2"
        cpu:
          type: string
          description: "NSK: CPU"
        enter_params:
          maxLength: 255
          minLength: 0
          type: string
          description: "BS2000: Enter Parameter"
        vms_queue_name:
          maxLength: 31
          minLength: 0
          type: string
          description: "VMS: Queue Name"
        unix_type:
          maxLength: 1
          minLength: 0
          type: string
          description: "Unix Job type, command='B', Shell Script=''"
        unix_cmd:
          maxLength: 255
          minLength: 0
          type: string
          description: "Unix: Command"
        unix_shell_options:
          maxLength: 16
          minLength: 0
          type: string
          description: "Unix: Shell Options"
        unix_shell:
          maxLength: 8
          minLength: 0
          type: string
          description: "Unix: Shell"
      description: job attributes
    jobf:
      title: File Transfer
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        file_transfer_attributes:
          $ref: '#/components/schemas/file_transfer_attributes'
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/ScriptsWithPost'
        output_filter_definitions:
          type: array
          items:
            $ref: '#/components/schemas/output_filter_definitions'
    jobg:
      title: Job Group
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        scripts:
          $ref: '#/components/schemas/ScriptsProcessOnly'
        group_attributes:
          $ref: '#/components/schemas/group_attributes'
    jobp:
      title: Workflow
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        scripts:
          $ref: '#/components/schemas/ScriptsProcessOnly'
        workflow_attributes:
          $ref: '#/components/schemas/workflow_attributes'
        workflow_definitions:
          type: array
          items:
            $ref: '#/components/schemas/workflow_definitions'
        line_conditions:
          type: array
          items:
            $ref: '#/components/schemas/line_conditions'
        calendar_conditions:
          type: array
          items:
            $ref: '#/components/schemas/calendar_conditions'
        prompt_elements:
          type: array
          items:
            $ref: '#/components/schemas/prompt_elements'
        prompt_array_elements:
          type: array
          items:
            $ref: '#/components/schemas/prompt_array_elements'
        extended_task_values:
          type: array
          items:
            $ref: '#/components/schemas/extended_task_values'
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/conditions'
        condition_values:
          type: array
          items:
            $ref: '#/components/schemas/condition_values'
        condition_parameters:
          type: array
          items:
            $ref: '#/components/schemas/condition_parameters'
        foreach_definitions:
          $ref: '#/components/schemas/foreach_definitions'
    jobq:
      title: Remote Task Manager
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        rtm_attributes:
          $ref: '#/components/schemas/rtm_attributes'
        rtm_filters:
          type: array
          items:
            $ref: '#/components/schemas/rtm_filters'
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/ScriptsWithPost'
        output_filter_definitions:
          type: array
          items:
            $ref: '#/components/schemas/output_filter_definitions'
    jobs:
      title: Job
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        job_attributes:
          $ref: '#/components/schemas/job_attributes'
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/ScriptsOfJob'
        jobstep_return_codes:
          type: array
          items:
            $ref: '#/components/schemas/jobstep_return_codes'
        extended_values:
          type: array
          items:
            $ref: '#/components/schemas/extended_values'
        output_filter_definitions:
          type: array
          items:
            $ref: '#/components/schemas/output_filter_definitions'
        external_output_files:
          type: array
          items:
            $ref: '#/components/schemas/external_output_files'
    jobstep_return_codes:
      required:
      - retcodes
      - step_name
      type: object
      properties:
        step_name:
          maxLength: 40
          minLength: 0
          type: string
          description: Name of the job step.
        retcodes:
          maxLength: 32
          minLength: 0
          type: string
          description: "Range of return codes. Format: 0,1,3-5"
        result:
          type: integer
          description: "Indicates whether a job fails if the return code is within\
            \ the range of defined return codes. 0 = abend on defined return code,\
            \ 1 succeed on defined return code"
          format: int32
          enum:
          - 1
          - 0
          default: 0
      description: jobstep retcodes of z/OS Jobs
    jsch:
      title: Schedule
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        scripts:
          $ref: '#/components/schemas/ScriptsProcessOnly'
        schedule_attributes:
          $ref: '#/components/schemas/schedule_attributes'
        workflow_definitions:
          type: array
          items:
            $ref: '#/components/schemas/workflow_definitions'
        calendar_conditions:
          type: array
          items:
            $ref: '#/components/schemas/calendar_conditions'
        prompt_elements:
          type: array
          items:
            $ref: '#/components/schemas/prompt_elements'
        prompt_array_elements:
          type: array
          items:
            $ref: '#/components/schemas/prompt_array_elements'
    line_conditions:
      required:
      - predecessor_line_number
      - workflow_line_number
      type: object
      properties:
        workflow_line_number:
          minimum: 1
          type: integer
          description: Sequenced number. Line number within the workflow.
          format: int32
        predecessor_line_number:
          minimum: 1
          type: integer
          description: Sequenced number of the predesessor.
          format: int32
        line_definition:
          maxLength: 255
          minLength: 0
          type: string
          description: "Definition of the line. Format: aaa/bbb/c/d, aaa = row, bbb\
            \ = column, c = position, d = width of the line"
        ok_status:
          maxLength: 30
          minLength: 0
          type: string
          description: "Possible success status of the line's precondition (e.g. ANY_OK,\
            \ ENDED_SKIPPED, ENDED_NOT_OK)."
        line_name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the line.
        branch_type:
          type: integer
          description: "Type of branch in case of a IF or FOREACH workflow. IF: 1\
            \ = true branch, 2 = false branch, FOREACH: 1 = loop path, 2= end path"
          format: int32
          enum:
          - 1
          - 2
      description: jobplan after
    link:
      type: object
      properties:
        link:
          title: Link
          required:
          - generalAttributes
          type: object
          properties:
            metadata:
              $ref: '#/components/schemas/metadata'
            generalAttributes:
              $ref: '#/components/schemas/LinkGeneralAttributes'
    login:
      title: Login
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        logins:
          type: array
          items:
            $ref: '#/components/schemas/logins'
    logins:
      required:
      - agent
      - login
      - platform
      type: object
      properties:
        platform:
          maxLength: 200
          minLength: 0
          type: string
          description: Type of the password according to HostAttrType (=platform of
            the agent)
        agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the agent.
        login:
          maxLength: 200
          minLength: 0
          type: string
          description: Login information.
        olc_vault:
          maxLength: 255
          minLength: 0
          type: string
          description: AutomationEngine or external vault (e.g. CyberArk)
      description: login object content
    members:
      type: object
      properties:
        username:
          type: string
      description: Users that are assigned to this User Group.
    metadata:
      type: object
      properties:
        version:
          type: string
          description: Contains the major and minor version of the AE that exported
            this object.
          example: "12.3"
      description: Contains meta data about the object.
    notification_attributes:
      type: object
      properties:
        escalation_time:
          maximum: 9999
          minimum: 0
          type: integer
          description: Escalation time in minutes.
          format: int32
        alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the escalation object.
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
        type:
          type: integer
          description: "Type of notification object. 0 = question, 1 = message, 2\
            \ = alarm, 3 = email"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
        priority:
          type: integer
          description: "Priority of the notification. 1 = high, 2 = normal, 3 = low"
          format: int32
          enum:
          - 1
          - 2
          - 3
        content:
          type: array
          items:
            type: string
            description: Content/body of the notification.
        execute:
          maxLength: 255
          minLength: 0
          type: string
          description: Action to be executed. (e.g. play .wav file)
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the notification object.
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        auto_quit:
          maxLength: 1
          minLength: 0
          type: string
          description: Indicates whether or not the notification object quits automatically
            when the escalation hits. J = quit automatically on escalation
        external_notification:
          type: integer
          description: "Type of external notification. 1 = snmp, 2 = email"
          format: int32
          enum:
          - 1
          - 2
        subject:
          maxLength: 255
          minLength: 0
          type: string
          description: Subject (for email only)
        attachments_run_id:
          maxLength: 32
          minLength: 0
          type: string
          description: RunId or a script variable which returns a RunId. Attach all
            available reports of the RunId's task.
        attachment_path:
          maxLength: 255
          minLength: 0
          type: string
          description: Path of a file to attach.
        source_of_reports:
          type: integer
          description: "Source of attached reports. 0 = database, 1 = external files,\
            \ 2 = all"
          format: int32
          enum:
          - 0
          - 1
          - 2
      description: notification attributes
    notification_content:
      type: object
      properties:
        calendar:
          maxLength: 200
          type: string
          description: Name of a calendar object.
        calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of a calendar event.
        user_id:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of a user or a user group.
        email:
          maxLength: 255
          minLength: 0
          type: string
          description: Email address.
      description: notification content
    object_variables:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the object variable.
        value:
          type: string
          description: Value of the object variable.
        ert_usage:
          type: integer
          description: "Indicates that the variable is used for the ERT calculation.\
            \ 0 = not used for ERT calculation, 1 = nominal, 2 = numeric, 3 = timestamp,\
            \ 4 = date, 5 = time"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          default: 0
      description: object values
    output_filter_definitions:
      required:
      - filter_name
      type: object
      properties:
        filter_name:
          maxLength: 255
          minLength: 0
          type: string
          description: Name of the filter object.
        result:
          type: integer
          description: Indicates whether the filter result should be true (1) or false
            (0).
          format: int32
          enum:
          - 0
          - 1
          default: 0
        retcode:
          minimum: 0
          type: integer
          description: Defines the return code.
          format: int32
          default: 0
        execute:
          maxLength: 255
          minLength: 0
          type: string
          description: Name of the object to be executed.
        message_insert:
          maxLength: 100
          minLength: 0
          type: string
          description: Status text
      description: Object Post Process Filter
    period_attributes:
      type: object
      properties:
        frequence_mode:
          type: integer
          description: "Frequence mode. 0 = every, 1 = gap, 2 = once"
          format: int32
          enum:
          - 0
          - 1
          - 2
        every:
          minimum: 1
          type: integer
          description: Seconds for setting 'every'.
          format: int32
        gap:
          minimum: 0
          type: integer
          description: Seconds for setting 'gap'.
          format: int32
        once:
          maxLength: 4
          minLength: 0
          type: string
          description: "Time for setting 'once'. Format: HHMM"
        overlap:
          type: integer
          description: "Defines whether one overlapse is allowed or not. 0 = no overlap\
            \ allowed, 1 = one overlap allowed"
          format: int32
          enum:
          - 0
          - 1
        from_time:
          maxLength: 4
          minLength: 0
          type: string
          description: "Start time of the time frame. Format: HHMM"
        to_time:
          maxLength: 4
          minLength: 0
          type: string
          description: "End time of the time frame: Format: HHMM"
        adjust:
          type: integer
          description: "Indicates whether the period needs to adjust to the time frame\
            \ or not. 0 = no adjustment, 1 = adjust to time frame"
          format: int32
          enum:
          - 0
          - 1
        range_mode:
          type: string
          description: "Defines the end mode of the range. 0 = no end, 1 = use end\
            \ date, 2 = use maximum number of runs defined"
          enum:
          - "0"
          - "1"
          - "2"
        range_start:
          type: string
          description: Start date of the range.
        range_end:
          type: string
          description: End date of the range. (optional)
        max_runs:
          maximum: 9999
          minimum: 1
          type: integer
          description: Defines the maximum number of occurencies.
          format: int32
        days_mode:
          type: string
          description: "How to define the days the period object should be activated.\
            \ <empty> = daily, W = weekdays, C = based on calendar conditions"
          enum:
          - W
          - C
        weekdays:
          maxLength: 8
          minLength: 0
          type: string
          description: Defines on what days the period object should be activated.
            (e.g. 12345 for Monday to Friday or ';')
        calendar_conditions:
          type: string
          description: "Defines how many calendar conditions have to match to activate\
            \ the period object. 1 = all conditions match, 2 = one condition matches,\
            \ 3 = no condition matches"
          enum:
          - "1"
          - "2"
          - "3"
      description: Period Object attributes
    prompt_array_elements:
      required:
      - line_number
      - variable_name
      type: object
      properties:
        workflow_line_number:
          minimum: 1
          type: integer
          description: Sequenced number of the workflow tasks.
          format: int32
        prompt_set_line_number:
          minimum: 1
          type: integer
          description: Sequenced number within the prompt set list.
          format: int32
        variable_name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the value or the prompt set element.
        line_number:
          minimum: 1
          type: integer
          description: Sequenced number for the prompt set array elements.
          format: int32
        value:
          type: string
          description: Value of the prompt set array element.
      description: Prompt Usage in Workflow/Schedule Task on Array
    prompt_elements:
      required:
      - line_number
      - prompt_set
      - prompt_set_line_number
      - variable_name
      type: object
      properties:
        line_number:
          minimum: 1
          type: integer
          description: Sequenced number of the workflow tasks.
          format: int32
        prompt_set_line_number:
          minimum: 0
          type: integer
          description: Sequenced number within the prompt set list.
          format: int32
        prompt_set:
          maxLength: 200
          minLength: 0
          type: string
          description: Prompt set name.
        variable_name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the value or the prompt set element.
        type:
          type: string
          description: "Type of value. 1 = value, 2 = prompted value"
          enum:
          - "1"
          - "2"
        value:
          type: string
          description: Value or variable mapping to parent (&abc#) or system values
        has_list:
          type: integer
          description: Indicates if this value uses an array.
          format: int32
          enum:
          - 0
          - 1
        alternative_view:
          type: integer
          description: Flag for alternative view.
          format: int32
          enum:
          - 0
          - 1
      description: Prompt Usage in Workflow/Schedule Task
    prompt_set_array_defaults:
      required:
      - line_number
      - name
      - prompt_set_element_number
      type: object
      properties:
        prompt_set_element_number:
          minimum: 1
          type: integer
          description: Line number of the prompt set within the object.
          format: int32
        name:
          maxLength: 32
          minLength: 0
          type: string
          description: Variable name of the array element.
        line_number:
          type: integer
          description: Sequenced number of the array element.
          format: int32
        value:
          type: string
          description: Default value of the array element.
      description: Prompt Usage - Prompt Set Element Defaults on Array
    prompt_set_defaults:
      required:
      - prompt_set
      - variable_name
      type: object
      properties:
        variable_name:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the prompt set variable.
        prompt_set:
          maxLength: 200
          type: string
          description: Name of the prompt set.
        has_list:
          type: integer
          description: Indicates whether or not this variable is an array or a list.
          format: int32
          enum:
          - 0
          - 1
          default: 0
        value:
          type: string
          description: Default value of this prompt set element.
        alternative_view:
          type: integer
          description: Flag for an alternative view.
          format: int32
          enum:
          - 0
          - 1
          default: 0
      description: Prompt Usage - PromptSet defaults differing from values of the
        PromptSet object
    prompt_set_list:
      required:
      - line_number
      - prompt_set
      type: object
      properties:
        line_number:
          type: integer
          description: Sequenced number for the prompt sets.
          format: int32
        prompt_set:
          maxLength: 200
          type: string
          description: Name of the prompt set.
        display_order:
          minimum: 1
          type: integer
          description: Display order in the UI. Starting with one.
          format: int32
      description: Prompt Usage - Prompt Set List
    prpt:
      title: PromptSet
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        gui_description:
          $ref: '#/components/schemas/gui_description'
        elements:
          type: array
          items:
            $ref: '#/components/schemas/elements'
        array_elements:
          type: array
          items:
            $ref: '#/components/schemas/array_elements'
    queue:
      title: Queue
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        queue_attributes:
          $ref: '#/components/schemas/queue_attributes'
        validation_period:
          type: array
          items:
            $ref: '#/components/schemas/validation_period'
    queue_attributes:
      type: object
      properties:
        consider_ert:
          type: integer
          description: Indicates whether or not the estimated runtime (ERT) is considered
            or not.
          format: int32
          enum:
          - 0
          - 1
        is_client_queue:
          type: integer
          description: Indicates whether the queue is a client queue or not.
          format: int32
          enum:
          - 0
          - 1
        is_stopped:
          type: integer
          description: Indicates whether this queue is stopped or not.
          format: int32
          enum:
          - 0
          - 1
          - 2
        max_slots:
          type: integer
          description: Defines the maximum number of parallel tasks that can run in
            this queue. -1 = unlimited
          format: int32
        temp_priority:
          maximum: 255
          minimum: 0
          type: integer
          description: Temporary priority of the objects that run in the queue.
          format: int32
        temp_max_slots:
          type: integer
          description: Temporary number of slots available of the queue.
          format: int32
        use_temporary:
          type: integer
          description: "Indicates whether or not the temporary values (priority, max.\
            \ number of slots) are enabled or not."
          format: int32
          enum:
          - 0
          - 1
      description: queue attributes
    rollback_definitions:
      type: object
      properties:
        backup_object:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the custom backup object that will be executed.
        rollback_object:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the custom rollback object that will be executed.
        backup_path:
          maxLength: 255
          minLength: 0
          type: string
          description: File backup Path.
        delete_files_before_restore:
          type: integer
          description: Indicates whether or not files are deleted before the start
            of the restore.
          format: int32
          enum:
          - 0
          - 1
        include_sub_directories:
          type: integer
          description: Indicates whether or not sub-directories will be included.
          format: int32
          enum:
          - 0
          - 1
      description: Rollback definition
    rtm_attributes:
      required:
      - type
      type: object
      properties:
        type:
          type: integer
          description: "Type of the Remote Task Manager. 6400=SAP All Jobs, 6401=SAP\
            \ Intercepted Jobs, 6402=PeopleSoft, 6403=SAP Java Jobs, 6404=SAP Process\
            \ Chains"
          format: int32
          enum:
          - 6400
          - 6401
          - 6402
          - 6403
          - 6404
        agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the destination agent.
        platform:
          maxLength: 8
          minLength: 0
          type: string
          description: Platform the children run on.
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
        start_jobs:
          type: string
          description: "Indicates whether or not external jobs are started. 0 = no,\
            \ 1 = yes"
          enum:
          - "0"
          - "1"
        auto_terminate:
          type: string
          description: "Indicates whether or not the task is terminated automatically\
            \ on the remote system. 0 = no, 1 = yes"
          enum:
          - "0"
          - "1"
        replicate_children:
          type: string
          description: "Indicates whether or not children can be replicated. 0 = no,\
            \ 1 = yes"
          enum:
          - "0"
          - "1"
        ok_status:
          minimum: 0
          type: integer
          description: Up to this return code the external task ends successfully
            (ENDED_OK).
          format: int32
        error_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Alarm object that is activated in the case an external task
            fails.
        output_path:
          maxLength: 8
          minLength: 0
          type: string
          description: The destination of the reports.
        max_parallel:
          minimum: 0
          type: integer
          description: Maximum number of parallel running tasks.
          format: int32
        polling_interval:
          minimum: 0
          type: integer
          description: Polling interval of the remote task manager within the agent.
            0 = job check interval is used
          format: int32
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the object.
        ressource:
          minimum: 0
          type: integer
          description: Number of resources needed for each child task. 0 = value from
            UC_SYSTEM_SETTINGS
          format: int32
      description: Attributes of Remote Task Manager
    rtm_filters:
      required:
      - filter_message_number
      - operator
      - type
      type: object
      properties:
        type:
          maxLength: 1
          minLength: 0
          type: string
          description: Data type of the value that is going to be checked.
        operator:
          type: string
          description: "The operator used. O = or, N = not, G = greater, L = less,\
            \ E = equals"
          enum:
          - O
          - "N"
          - G
          - L
          - E
        filter_message_number:
          type: integer
          description: Filter for message number.
          format: int32
        filter_text:
          maxLength: 255
          minLength: 0
          type: string
          description: Filter for a certain text.
        filter_integer:
          minimum: 0
          type: integer
          description: Filter for a certain number.
          format: int32
        filter_date:
          type: string
          description: Filter for a certain date.
      description: Filters of Remote Task Manager
    schedule_attributes:
      required:
      - period
      type: object
      properties:
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the object.
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
        period:
          minimum: 1
          type: integer
          description: Defines the duration of the period (in days).
          format: int32
        start_time:
          type: string
          description: Start time of the period.
        ok_status:
          maxLength: 30
          minLength: 0
          type: string
          description: The status range for a successful run.
        error_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Alarm object that is activated if a run fails.
      description: schedule attributes
    scri:
      title: Script
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/custom_attributes'
        sync_list:
          type: array
          items:
            $ref: '#/components/schemas/sync_list'
        object_variables:
          type: array
          items:
            $ref: '#/components/schemas/object_variables'
        prompt_set_list:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_list'
        prompt_set_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_defaults'
        prompt_set_array_defaults:
          type: array
          items:
            $ref: '#/components/schemas/prompt_set_array_defaults'
        rollback_definitions:
          $ref: '#/components/schemas/rollback_definitions'
        scripts:
          $ref: '#/components/schemas/ScriptsProcessOnly'
        script_attributes:
          $ref: '#/components/schemas/script_attributes'
    script_attributes:
      type: object
      properties:
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the job.
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        attribute_dialog:
          type: integer
          description: "Indicates, whether or not the attribute dialog is opened when\
            \ the object is started."
          format: int32
          enum:
          - 0
          - 1
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
      description: script attributes
    slo:
      title: Service Level Objective
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        slo_attributes:
          $ref: '#/components/schemas/slo_attributes'
        beneficiaries:
          type: array
          items:
            $ref: '#/components/schemas/beneficiaries'
    slo_attributes:
      type: object
      properties:
        monitor_mode:
          type: integer
          description: "Indicates whether the objective is permanently monitored or\
            \ not. 0 = permanently, 1 = restricted"
          format: int32
          enum:
          - 0
          - 1
        service_query:
          type: array
          items:
            type: string
            description: Line of the output from service query builder. Stored in
              json or xml format.
        consider_mrt:
          type: integer
          description: Indicates whether the maximum runtime (MRT) is considered for
            the fulfillment of the service level objective or not.
          format: int32
          enum:
          - 0
          - 1
        consider_srt:
          type: integer
          description: Indicates whether the shortest runtime (SRT) is considered
            for the fulfillment of the service level objective or not.
          format: int32
          enum:
          - 0
          - 1
        consider_status:
          type: integer
          description: Indicates whether the end status of a task is considered for
            the fulfillment of the service level objective or not.
          format: int32
          enum:
          - 0
          - 1
        expect_status:
          maxLength: 30
          minLength: 0
          type: string
          description: Defines the expected status or status range (e.g. ANY_OK or
            ENDED_OK).
        execute_on_fullfilment:
          type: integer
          description: Indicates that an object is started if a service level objective
            is fulfilled.
          format: int32
          enum:
          - 0
          - 1
        alarm_on_fulfillment:
          maxLength: 200
          minLength: 0
          type: string
          description: Object to start if a service level objective is fulfilled.
        email_on_fulfillment:
          type: integer
          description: Indicates that an email is sent if a service level objective
            is fulfilled.
          format: int32
          enum:
          - 0
          - 1
        recipients_on_fulfillment:
          type: string
          description: List of email recipients to inform on fulfillment of the service
            level objective. Email recipients are separated by ';'.
        execute_on_violation:
          type: integer
          description: Indicates that an object is started if a service level objective
            is violated.
          format: int32
          enum:
          - 0
          - 1
        alarm_on_violation:
          maxLength: 200
          minLength: 0
          type: string
          description: Object to start if a service level objective is violated.
        email_on_violation:
          type: integer
          description: Indicates that an email is sent if a service level objective
            is violated.
          format: int32
          enum:
          - 0
          - 1
        recipients_on_violation:
          type: string
          description: List of email recipients to inform on violation of the service
            level objective. Email recipients are separated by ';'.
        consider_latest_start:
          type: integer
          description: Indicates whether or not the latest start time is considered
            for the fulfillment of the service level objective.
          format: int32
          enum:
          - 0
          - 1
        consider_latest_end:
          type: integer
          description: Indicates whether or not the latest end time is considered
            for the fulfillment of the service level objective.
          format: int32
          enum:
          - 0
          - 1
        latest_start_time:
          maxLength: 4
          minLength: 0
          type: string
          description: "Latest start time. Format: hhmm"
        latest_end_time:
          maxLength: 4
          minLength: 0
          type: string
          description: "Latest end time. Format: hhmm"
        weekdays:
          maxLength: 8
          minLength: 0
          type: string
          description: "Defines the weekdays the check is active: Format: 1234567"
        monitor_from:
          maxLength: 4
          minLength: 0
          type: string
          description: "Start time of monitoring window. Format: hhmm"
        monitor_to:
          maxLength: 4
          minLength: 0
          type: string
          description: "End time of monitoring window. Format: hhmm"
      description: Attribute table for flat attributes of an SLO object
    state_definitions:
      required:
      - state
      type: object
      properties:
        state:
          maxLength: 30
          minLength: 0
          type: string
          description: Definition of the sync state.
        description:
          maxLength: 80
          minLength: 0
          type: string
          description: Description of the sync state.
      description: sync definition
    static_values:
      required:
      - key
      - validity_range
      type: object
      properties:
        key:
          maxLength: 200
          minLength: 0
          type: string
          description: The identification key.
        client:
          type: integer
          format: int32
          writeOnly: true
        validity_range:
          type: string
          description: "Name of the validity range. *=No validity keyword, FREI=freely\
            \ selected, HON=Host - each host name, JBN=Job - each job name, JPN=Workflow\
            \ name - each Workflow name, \r\nJPS=Workflow session - each Workflow\
            \ session,\r\nUSN=User - each user name, USS=User session - each user\
            \ session"
          enum:
          - '*'
          - FREI
          - HON
          - JBN
          - JPN
          - JPS
          - USN
          - USS
        value1:
          type: string
          description: Text representation of value column 1.
        value2:
          type: string
          description: Text representation of value column 2.
        value3:
          type: string
          description: Text representation of value column 3.
        value4:
          type: string
          description: Text representation of value column 4.
        value5:
          type: string
          description: Text representation of value column 5.
        xml:
          type: string
          description: XML data for XML variable object.
      description: variable values
    sync:
      title: Sync
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        state_definitions:
          type: array
          items:
            $ref: '#/components/schemas/state_definitions'
        action_definitions:
          type: array
          items:
            $ref: '#/components/schemas/action_definitions'
        sync_states:
          $ref: '#/components/schemas/sync_states'
    sync_list:
      required:
      - sync_object
      type: object
      properties:
        sync_object:
          maxLength: 200
          type: string
          description: Name of the sync object.
        start_action:
          maxLength: 30
          minLength: 0
          type: string
          description: Start action to check the sync object.
        end_action:
          maxLength: 30
          minLength: 0
          type: string
          description: Action to be taken if the task ends normally.
        abend_action:
          maxLength: 30
          minLength: 0
          type: string
          description: Action to be taken if the task ends abnormally.
        else_action:
          type: string
          description: "Defindes the action if the sync object cannot be reserved.\
            \ W=Wait, A=abend, S=Skip"
          enum:
          - S
          - W
          - A
      description: sync use
    sync_states:
      required:
      - value
      type: object
      properties:
        status:
          maxLength: 30
          minLength: 0
          type: string
          description: The actual state of the sync object.
        value:
          type: integer
          description: The actual numeric value of the sync state.
          format: int32
      description: Sync state
    timezone_attributes:
      required:
      - year
      type: object
      properties:
        year:
          minimum: 0
          type: integer
          description: Year
          format: int32
        time_diff_utc_hours:
          type: integer
          description: Time difference (hours) to UTC.
          format: int32
        time_diff_utc_minutes:
          type: integer
          description: Time difference (minutes) to UTC.
          format: int32
        dst_start_month:
          type: integer
          description: Month for start of daylight saving time (dst). (e.g. second
            Sunday of 'March')
          format: int32
        dst_start_ordinal:
          type: integer
          description: Ordinal number (1 to 5) of the day for start of daylight saving
            time. (e.g. 'second' Sunday of March)
          format: int32
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
        dst_start_weekday:
          type: integer
          description: Weekday (1 = Monday to 7 = Sunday) on which the daylight saving
            time starts. (e.g second 'Sunday' of March)
          format: int32
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
        dst_start_hour:
          type: integer
          description: Hour the daylight saving time starts.
          format: int32
        dst_start_minutes:
          type: integer
          description: Minute the daylight saving time starts.
          format: int32
        dst_end_month:
          type: integer
          description: Month for end of daylight saving time. (e.g. second Sunday
            of 'November')
          format: int32
        dst_end_ordinal:
          type: integer
          description: Ordinal number (1 to 5) of the day for end of daylight saving
            time. (e.g. 'second' Sunday of November)
          format: int32
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
        dst_end_weekday:
          type: integer
          description: Weekday (1 = Monday to 7 = Sunday) on which the daylight saving
            time ends. (e.g second 'Sunday' of November)
          format: int32
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
        dst_end_hour:
          type: integer
          description: Hour the daylight saving time ends.
          format: int32
        dst_end_minutes:
          type: integer
          description: Minute the daylight saving time ends.
          format: int32
        time_diff_dst_st:
          type: integer
          description: Time difference between daylight savint and standard time.
          format: int32
      description: Time zone content
    user_group_attributes:
      required:
      - privileges
      type: object
      properties:
        home_folder:
          maxLength: 200
          minLength: 0
          type: string
          description: Fix mounted home folder for the user.
        privileges:
          type: number
          description: Bit array of privileges the user group posseses.
      description: user groups
    validation_period:
      required:
      - from
      - to
      type: object
      properties:
        calendar:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar.
        calendar_event:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the calendar event.
        from:
          maxLength: 4
          minLength: 0
          type: string
          description: "From-time of the validation period. Format: HHMM"
        to:
          maxLength: 4
          minLength: 0
          type: string
          description: "End-time of the validation period. Format: HHMM"
        max_slots:
          minimum: 0
          type: integer
          description: Maximum number of slots within the queue.
          format: int32
        priority:
          maximum: 255
          minimum: 0
          type: integer
          description: Defines the priority.
          format: int32
        description:
          maxLength: 255
          minLength: 0
          type: string
          description: Stores the description.
      description: validation period
    vara:
      title: Variable
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
        variable_definitions:
          $ref: '#/components/schemas/variable_definitions'
        static_values:
          type: array
          items:
            $ref: '#/components/schemas/static_values'
        backend_tabs:
          type: array
          items:
            $ref: '#/components/schemas/backend_tabs'
        commands:
          type: array
          items:
            $ref: '#/components/schemas/commands'
        bind_parameters:
          type: array
          items:
            $ref: '#/components/schemas/bind_parameters'
    variable_definitions:
      required:
      - data_type
      - on_not_found
      - type
      - validity_range
      type: object
      properties:
        data_type:
          type: string
          description: "Defines the data type of the variable object. C = text, D\
            \ = date, N = number, TI = time, TS = timestamp"
          enum:
          - C
          - D
          - "N"
          - TI
          - TS
        validity_range:
          type: string
          description: "Name of the validity range. *=No validity keyword, FREI=freely\
            \ selected, HON=Host - each host name, JBN=Job - each job name, JPN=Workflow\
            \ name - each Workflow name, \r\nJPS=Workflow session - each Workflow\
            \ session,\r\nUSN=User - each user name, USS=User session - each user\
            \ session"
          enum:
          - '*'
          - FREI
          - HON
          - JBN
          - JPN
          - JPS
          - USN
          - USS
        on_not_found:
          type: string
          description: "Defines what happens if the key cannot be found. Abend task\
            \ with an error message or return the initial value. E = eror, I = initial"
          enum:
          - E
          - I
        output_format:
          maxLength: 32
          minLength: 0
          type: string
          description: Defines the output format of the value.
        min_value:
          maxLength: 64
          minLength: 0
          type: string
          description: Minimum value that is allowed.
        max_value:
          maxLength: 64
          minLength: 0
          type: string
          description: Maximum allowed value or maximum string length that is allowed.
        to_uppercase:
          type: integer
          description: Indicates whether or not the value is converted to upper case
            (text only).
          format: int32
          enum:
          - 0
          - 1
        type:
          maxLength: 8
          minLength: 0
          type: string
          description: "Defines the type of the variable (e.g. STATIC, BACKEND, SEC_SQL). "
        column_count:
          minimum: 0
          type: integer
          description: Number of additional columns.
          format: int32
        login:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the login object used for the dynamic variable.
        prefer_user_login:
          type: integer
          description: Indicates the the user login object is preferred over the login
            object defined within the variable.
          format: int32
          enum:
          - 0
          - 1
        connection:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the connection object. Used for SQL and SEC_SQL variables.
        sql:
          maxItems: 4096
          minItems: 0
          type: array
          items:
            maxLength: 4096
            type: string
            description: Line of the SQL query that is executed on the database server.
        sql_oracle:
          maxItems: 4096
          minItems: 0
          type: array
          items:
            maxLength: 4096
            type: string
            description: The defined SQL query for SQLI and SEC_SQLI variables that
              use Oracle.
        sql_db2:
          maxItems: 4096
          minItems: 0
          type: array
          items:
            maxLength: 4096
            type: string
            description: The defined SQL query for SQLI and SEC_SQLI variables that
              use DB2.
        result_format:
          maxLength: 1024
          minLength: 0
          type: string
          description: "The result format defines the result column that is added\
            \ to the result set. (e.g. {1}_{2})"
        variable_object1:
          maxLength: 200
          minLength: 0
          type: string
          description: Defines the first variable used inside a MULTI variable.
        variable_object2:
          maxLength: 200
          minLength: 0
          type: string
          description: Defines the second variable used inside a MULTI variable.
        operator:
          type: integer
          description: "Defines the merge operation (intersect) executed when resolving\
            \ a MULTI variable. 0 = union, 1 = intersection, 2 = minus)"
          format: int32
          enum:
          - 0
          - 1
          - 2
        directory:
          maxLength: 255
          minLength: 0
          type: string
          description: Defines the directory whose file names are returned. (FILELIST
            only)
        agent:
          maxLength: 200
          minLength: 0
          type: string
          description: Defines the agent the variable will be executed.
        prefer_task_agent:
          type: integer
          description: Defines whether or not the agent of the task is preferred.
          format: int32
          enum:
          - 0
          - 1
        prefer_task_login:
          type: integer
          description: Defines whether or not the agent of the login is preferred.
          format: int32
          enum:
          - 0
          - 1
        sort_column:
          type: integer
          description: "Defines which column is the one which gets sorted. 0 = key,\
            \ 1 = column 1, 2 = column 2, etc."
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
        sort_order:
          type: string
          description: Defines the sort order of the column that gets sorted.
          enum:
          - "0"
          - "1"
        object_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the object that will be executed. (VARA.EXEC only)
        result_variable:
          maxLength: 32
          minLength: 0
          type: string
          description: Name of the object variable that stores the result. (VARA.EXEC
            only)
        sql_postgres:
          maxItems: 4096
          minItems: 0
          type: array
          items:
            maxLength: 4096
            type: string
            description: The SQL-statement for Postgre
      description: variable definition
    workflow_attributes:
      type: object
      properties:
        account:
          maxLength: 16
          minLength: 0
          type: string
          description: Name of the internal account.
        start_type:
          maxLength: 200
          minLength: 0
          type: string
          description: Start type of the job.
        activation_at_runtime:
          type: integer
          description: Indicates that the object is generated at runtime or at activation
            time.
          format: int32
          enum:
          - 0
          - 1
        ok_status:
          maxLength: 30
          minLength: 0
          type: string
          description: The status range for a successful run.
        error_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Alarm object that is activated if a run fails.
        reuse_agent_group:
          type: integer
          description: "Indicates, that the agent group resolution is re-used within\
            \ the workflow. 0 = No, 1 = Yes"
          format: int32
          enum:
          - 0
          - 1
        sub_type:
          maxLength: 2
          minLength: 0
          type: string
          description: "Indicates the type of the sub-type of the workflow. empty\
            \ = standard workflow, IF = if workflow, FE = foreach workflow"
        deployment_workflow:
          type: integer
          description: Is deployment tab active or not.
          format: int32
          enum:
          - 0
          - 1
        deployment_workflow_type:
          type: integer
          description: "Type of the deployment workflow. 0 = standard workflow, 1\
            \ = application workflow, 2 = component workflow"
          format: int32
          enum:
          - 0
          - 1
          - 2
        deployment_application_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the deployment application.
        deployment_component_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the deployment component.
        deployment_workflow_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the deployment workflow.
        inherit_priority:
          type: integer
          description: Pass the workflow priority onto its children.
          format: int32
          enum:
          - 0
          - 1
      description: Workflow attributes
    workflow_definitions:
      required:
      - object_name
      type: object
      properties:
        line_number:
          type: integer
          description: Sequenced number of the workflow tasks.
          format: int32
        object_type:
          maxLength: 8
          minLength: 0
          type: string
          description: Type of the workflow task.
        object_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the workflow task.
        earliest_start_time:
          maxLength: 10
          minLength: 0
          type: string
          description: Earliest start time of the workflow task.
        latest_start_time:
          maxLength: 10
          minLength: 0
          type: string
          description: Latest start time of the workflow task.
        latest_end_time:
          maxLength: 10
          minLength: 0
          type: string
          description: Latest end time of the workflow task.
        precondition_error_action:
          type: string
          description: "Defines the action that will be triggered, if the status of\
            \ any predecessor is not successful. S = skip, H = halt, A = abend, X\
            \ = block and abort"
          enum:
          - S
          - H
          - A
          - X
        precondition_type:
          maxLength: 1
          minLength: 0
          type: string
          description: Conjunction for the pre-conditions.
        calendar_condition_type:
          type: string
          description: "Calendar condition of the workflow task. 1 = and, 2 = equal,\
            \ 3 = not equal, 4 = ext."
          enum:
          - "1"
          - "2"
          - "3"
          - "4"
        predecessors:
          minimum: 0
          type: integer
          description: Number of this workflow task's predecessors.
          format: int32
        row:
          type: integer
          description: y-coordinate of the workflow task (for the graphical representation
            within the workflow editor/monitor).
          format: int32
        column:
          type: integer
          description: x-coordinate of the workflow task (for the graphical representation
            within the workflow editor/monitor).
          format: int32
        precondition_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: "Name of the object, that will be triggered, if the status\
            \ of any predecessor is not successful."
        active:
          type: integer
          description: "bit 1: active/inactive, bit 2: hold/normal"
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
        postcondition_ok_status:
          maxLength: 30
          minLength: 0
          type: string
          description: "Possible success status of the line's precondition (e.g. ANY_OK,\
            \ ENDED_SKIPPED, ENDED_NOT_OK)."
        postcondition_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: "Name of the object, that will be triggered, if the workflow\
            \ task does not end successfully."
        postcondition_action:
          type: integer
          description: "Workflow action, that will be triggered, if the workflow task\
            \ does not end successfully. 1 = halt, 2 = ignore, 3 = abend workflow"
          format: int32
          enum:
          - 1
          - 2
          - 3
        postcondition_max_repeats:
          minimum: 0
          type: integer
          description: "Maximum number of repeats, if the workflow task does not end\
            \ successfully."
          format: int32
        postcondition_repeat_waittime:
          minimum: 0
          type: integer
          description: Wait time between retries in minutes.
          format: int32
        mrt_method:
          type: integer
          description: "Method for the maximum runtime. 0 = no audit, 1 = fix in seconds,\
            \ 2 = fix time, 4 = ERT+xx%, 256 = Cancel, 512 = Start Object, 1024 =\
            \ worflow overwrites object settings"
          format: int32
        mrt:
          minimum: 0
          type: integer
          description: Maximum runtime (MRT) in seconds.
          format: int32
        mrt_time:
          maxLength: 6
          minLength: 0
          type: string
          description: "Maxium runtime in time. Format: ddhhmm"
        mrt_ert:
          minimum: 0
          type: integer
          description: MRT = ERT + xx%
          format: int32
        mrt_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Object to start for runtime audit.
        tcp_after_time:
          maxLength: 6
          minLength: 0
          type: string
          description: after time > time
        tcp_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: Object to start.
        srt:
          minimum: 0
          type: integer
          description: Shortest runtime (SRT) in seconds.
          format: int32
        srt_ert:
          minimum: 0
          type: integer
          description: SRT = ERT + xx%
          format: int32
        timezone_time_check_point:
          maxLength: 8
          minLength: 0
          type: string
          description: Timezone for time check point.
        timezone_ert:
          maxLength: 8
          minLength: 0
          type: string
          description: Timezone for erleast start time.
        timezone_latest_time:
          maxLength: 8
          minLength: 0
          type: string
          description: Timezone for latest time.
        timezone_max_runtime:
          maxLength: 8
          minLength: 0
          type: string
          description: Timezone for max. Runtime when a fixed time is used.
        connected_to_end:
          type: integer
          description: Indicates whether or not the workflow task is connected to
            the end task.
          format: int32
          enum:
          - 0
          - 1
        postcondition_execute_flag:
          type: integer
          description: "Indicates when the alarm object is triggered. 0 = execute\
            \ after each unsuccessful execution, 1 = execute only after all retries\
            \ are unsuccessful"
          format: int32
          enum:
          - 0
          - 1
        external_predecessors:
          minimum: 0
          type: integer
          description: Number of external predecessors.
          format: int32
        parent_name:
          maxLength: 200
          minLength: 0
          type: string
          description: Name of the workflow. (only for external dependencies)
        ext_precondition_ok_status:
          maxLength: 30
          minLength: 0
          type: string
          description: "External Precondition: Possible success status (e.g. ANY_OK,\
            \ ENDED_SKIPPED, ENDED_NOT_OK)."
        ext_precondition_sltt:
          type: string
          description: "External Precondition: Type of the satisfaction lead time.\
            \ 0 = since last run, 1 = after start of workflow, 2 = within time in\
            \ seconds, 3 = same logical date as workflow"
          enum:
          - "0"
          - "1"
          - "2"
          - "3"
        ext_precondition_slt:
          minimum: 0
          type: integer
          description: "External Precondition: Time in seconds"
          format: int32
        ext_precondition_action:
          type: string
          description: "External Precondition: Workflow action that is triggered,\
            \ if the precondition fails. 0 = wait, 1 = skip, 2 = abend workflow"
          enum:
          - "0"
          - "1"
          - "2"
        ext_precondition_alarm_flag:
          type: string
          description: "External Precondition: Indicates whether or not an alarm object\
            \ is triggered, if the precondition fails. 0 = no, 1 = yes"
          enum:
          - "0"
          - "1"
        ext_precondition_timeout:
          minimum: 0
          type: integer
          description: "External Precondition: Timeout in seconds."
          format: int32
        ext_precondition_timeout_action:
          type: string
          description: "External Precondition: Workflow action that is triggered,\
            \ if the precondition timeout occurs. 0 = wait, 1 = Skip, 2 = abend workflow"
          enum:
          - "0"
          - "1"
          - "2"
        ext_precondition_timeout_alarm:
          type: string
          description: "External Precondition: Indicates whether or not an alarm object\
            \ is triggered, if the precondition timeout occurs. 0 = no, 1 = yes"
          enum:
          - "0"
          - "1"
        ext_precondition_alarm:
          maxLength: 200
          minLength: 0
          type: string
          description: "External Precondition: Name of the alarm object that is executed,\
            \ if the precondition fails."
        ext_precondition_timeout_flag:
          type: integer
          description: "External Precondition: Indicates whether or not the AE checks\
            \ for the timeout. 0 = off, 1 = on"
          format: int32
          enum:
          - 0
          - 1
        has_task_variables:
          type: integer
          description: Indicates whether or not workflow task has object variables
            in its task properties.
          format: int32
          enum:
          - 0
          - 1
        has_preconditions:
          type: integer
          description: Indicates whether or not workflow task has preconditions.
          format: int32
          enum:
          - 0
          - 1
        has_postconditions:
          type: integer
          description: Indicates whether or not workflow task has postconditions.
          format: int32
          enum:
          - 0
          - 1
        alias:
          maxLength: 200
          minLength: 0
          type: string
          description: Display name of the workflow task.
        parent_alias:
          maxLength: 200
          minLength: 0
          type: string
          description: Display name of the workflow task in external dependencies.
        childflags:
          maxLength: 16
          minLength: 0
          type: string
          description: Flags for child tables.
        show_prompt:
          type: integer
          description: Indicates whether or not prompts will be shown.
          format: int32
          enum:
          - 0
          - 1
        prompt_time:
          type: integer
          description: Show prompt during workflow generation or workflow task generation.
          format: int32
          enum:
          - 0
          - 1
        branch_type:
          type: integer
          description: "Type of branch in case of a IF or FOREACH workflow. IF: 1\
            \ = true, 2 = false, FOREACH: 1 = loop path, 2 = end path"
          format: int32
          enum:
          - 0
          - 1
          - 2
        run_per_patch:
          type: integer
          description: Indicates whether task is running per patch or not.
          format: int32
          enum:
          - 0
          - 1
        rollback_enabled:
          type: integer
          description: Indicates whether or not rollback is enabled for the workflow
            task. (overrides OH_RollbackFlag)
          format: int32
          enum:
          - 0
          - 1
        run_per_target:
          type: integer
          description: "Indicates how to run the workflow per deployment target. 1\
            \ = serial, 2 = parallel"
          format: int32
          enum:
          - 0
          - 1
          - 2
      description: Workflow/Schedule content
    xsl:
      title: Style Sheet
      required:
      - general_attributes
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/metadata'
        general_attributes:
          $ref: '#/components/schemas/general_attributes'
        documentation:
          type: array
          items:
            $ref: '#/components/schemas/documentation'
      description: Content is on documentation of type "XSL".
    InFolderObjects:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/folder'
    ApiDocAEObject:
      title: AE object
      type: object
      description: Serialized object in JSON format.
      oneOf:
      - $ref: '#/components/schemas/ApiDocHostg'
      - $ref: '#/components/schemas/ApiDocHsta'
      - $ref: '#/components/schemas/ApiDocCale'
      - $ref: '#/components/schemas/ApiDocCode'
      - $ref: '#/components/schemas/ApiDocConn'
      - $ref: '#/components/schemas/ApiDocDash'
      - $ref: '#/components/schemas/ApiDocDocu'
      - $ref: '#/components/schemas/ApiDocEvnt'
      - $ref: '#/components/schemas/ApiDocJobf'
      - $ref: '#/components/schemas/ApiDocFilter'
      - $ref: '#/components/schemas/ApiDocJobi'
      - $ref: '#/components/schemas/ApiDocJobs'
      - $ref: '#/components/schemas/ApiDocJobg'
      - $ref: '#/components/schemas/ApiDocLogin'
      - $ref: '#/components/schemas/ApiDocCall'
      - $ref: '#/components/schemas/ApiDocPeriod'
      - $ref: '#/components/schemas/ApiDocPrpt'
      - $ref: '#/components/schemas/ApiDocQueue'
      - $ref: '#/components/schemas/ApiDocJobq'
      - $ref: '#/components/schemas/ApiDocJsch'
      - $ref: '#/components/schemas/ApiDocScri'
      - $ref: '#/components/schemas/ApiDocSlo'
      - $ref: '#/components/schemas/ApiDocStore'
      - $ref: '#/components/schemas/ApiDocXsl'
      - $ref: '#/components/schemas/ApiDocSync'
      - $ref: '#/components/schemas/ApiDocTz'
      - $ref: '#/components/schemas/ApiDocUser'
      - $ref: '#/components/schemas/ApiDocUsrg'
      - $ref: '#/components/schemas/ApiDocVara'
      - $ref: '#/components/schemas/ApiDocJobp'
    OutObject:
      required:
      - data
      - hasmore
      - total
      type: object
      properties:
        total:
          type: integer
          description: Determines the total number of items.
          format: int32
          example: 1
        data:
          $ref: '#/components/schemas/ApiDocAEObject'
        path:
          type: string
          description: Object path
        client:
          type: integer
          description: Client of the object (current client or zero)
          format: int32
        hasmore:
          type: boolean
          description: Indicates if there are more results than currently returned.
          example: false
    OutTimeZoneInfo:
      type: object
      properties:
        name:
          type: string
          description: The name of the time zone object.
          example: TZ.CET.1
        client:
          type: integer
          description: Client of the time zone object
          format: int32
          example: 0
        offset_to_u_tc:
          type: string
          description: Offset to UTC right now.
          example: "120"
      description: Details of a time zone.
    InImportObjectBody:
      required:
      - data
      type: object
      properties:
        path:
          type: string
          description: Path to the automation engine target where the object should
            be located.
          example: FOLDER/SUBFOLDER
        data:
          $ref: '#/components/schemas/ApiDocAEObject'
    OutObjectReference:
      type: object
      properties:
        idnr:
          type: integer
          format: int32
        name:
          type: string
        title:
          type: string
        type:
          type: string
        platform:
          type: string
        folderpath:
          type: string
        lastmodified:
          type: string
          format: date-time
        openedby:
          type: string
        authorization_bitcode:
          type: integer
          format: int32
        context:
          type: array
          items:
            $ref: '#/components/schemas/OutObjectUsageContext'
        folderpathj:
          type: string
          writeOnly: true
    OutObjectUsage:
      type: object
      properties:
        references:
          type: array
          items:
            $ref: '#/components/schemas/OutObjectReference'
        references_without_a_c_l:
          type: boolean
        number_of_referencing_objects:
          type: integer
          format: int32
        total_number_of_references:
          type: integer
          format: int32
    OutObjectUsageContext:
      type: object
      properties:
        id:
          type: integer
          format: int32
        message:
          type: string
        insert:
          type: string
    OutRepoVersionEntry:
      required:
      - file_name
      type: object
      properties:
        file_name:
          type: string
          description: The file name of the object.
          example: temp/TestScript1.xml
        change_type:
          type: string
          description: How the object changed since its last commit
          example: ADD
          enum:
          - ADD
          - DELETE
          - MOVE
          - RENAME
          - MODIFY
      description: Encapsulates an automation engine object processed by the repository.
    OutRepositoryInit:
      required:
      - client
      - number_affected_objects
      - permission_missing_for_objects
      - status
      type: object
      properties:
        client:
          type: integer
          description: Client for which the repository was initialized.
          format: int32
          example: 100
        status:
          type: string
          description: Result status of the repository call.
          example: "SUCCESS, ERROR_PERMISSIONS etc."
        version_changes:
          type: array
          items:
            $ref: '#/components/schemas/OutRepoVersionEntry'
        permission_missing_for_objects:
          type: array
          items:
            type: string
            description: List of object names the user does not have write permission
              for.
            example: OBJ_A
        number_affected_objects:
          type: integer
          description: Amount of Automation Engine objects which were affected by
            the repository call.
          format: int32
          example: 100
        version_title:
          type: string
      description: Response that is sent when the repository is initialized.
    InRepositoryInit:
      required:
      - branch_name
      type: object
      properties:
        force_delete_existing_client:
          type: boolean
          description: Flag that indicates that the client should be initialized with
            an already existing repository. The content of the client (also users)
            will be deleted and replaced with objects from the client in the existing
            repository.
          example: true
        branch_name:
          type: string
          description: "If forceDeleteExistingClient is false, this is the name of\
            \ the new branch. Otherwise it is the name of the branch from which should\
            \ be initialized. Allowed pattern descriped at: <a href=\"https://git-scm.com/docs/git-check-ref-format\"\
            >https://git-scm.com/docs/git-check-ref-format</a>"
          example: develop
    OutRepositoryObject:
      required:
      - creation_date
      - idnr
      - last_user_name
      - mod_date
      - oh_name
      - oh_type
      type: object
      properties:
        idnr:
          type: integer
          description: The idnr of the object.
          format: int32
          example: 1234567
        oh_name:
          type: string
          description: The name of the object.
          example: TestScript1
        oh_type:
          type: string
          description: The type of the object.
          example: SCRI
        mod_date:
          type: string
          description: The date of the object's last modification.
          format: date-time
        creation_date:
          type: string
          description: The date of the object's creation.
          format: date-time
        last_user_name:
          type: string
          description: The name of the user who last modified the object.
          example: user_a
        archive_key1:
          type: string
          description: The object's archive key.
        archive_key2:
          type: string
          description: The object's archive key.
        change_type:
          type: string
          description: How the object changed since its last commit
          example: "ADD,DELETE,MOVE,RENAME,MODIFY"
      description: Encapsulates an automation engine object processed by the repository.
    OutRepositoryUncommittedChanges:
      required:
      - total
      type: object
      properties:
        total:
          type: integer
          description: How many uncommitted changes does the client have.
          format: int32
        data:
          type: array
          description: List of objects that have uncommitted changes
          items:
            $ref: '#/components/schemas/OutRepositoryObject'
      description: Response that is sent for the check how many automation engine
        objects have been changed and not yet committed.
    OutRepo:
      type: object
      properties:
        active_branch:
          type: string
          description: The name of the currently active branch
      description: Response that is sent when asked if the repository is created.
    OutRepositoryPull:
      required:
      - status
      type: object
      properties:
        status:
          type: string
          description: Status of the pull.
          example: successful
        fetch_messages:
          type: string
          description: Fetch error messages
          example: Invalid file paths etc
        merge_messages:
          type: string
          description: Merge error messages
          example: Invalid file paths etc
        pull_conflicts:
          type: array
          items:
            type: string
            description: Pull conflicts
            example: FOLDER1/OBJECT_A
      description: Result of a pull operation. Contains status and error messages
        if available.
    InRepositoryPull:
      required:
      - overwrite
      type: object
      properties:
        overwrite:
          type: boolean
          description: "If false, will stop the pull incase of conflicts with uncommitted\
            \ changes. If true, will execute the pull and if necessary, overwrite\
            \ in AE."
          example: true
    OutRepositoryDiff:
      required:
      - object_name
      type: object
      properties:
        object_name:
          type: string
          description: Name of the conflicting object.
          example: I.AM.CONFLICTING.SCRI
        ours:
          type: string
          description: Content of the local (active) file.
        theirs:
          type: string
          description: Content of the branch file which gets merged into active branch.
      description: Response of a merge conflict.
    OutRepositoryHistory:
      required:
      - data
      - hasmore
      - is_pull_required
      - total
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutRepositoryHistoryEntry'
        total:
          type: integer
          description: Determines the total number of items.
          format: int32
          example: 1
        is_pull_required:
          type: boolean
        hasmore:
          type: boolean
          description: Indicates if there are more results than currently returned.
          example: false
      description: Response that retrieves the history for the repository for max_results
        entries.
    OutRepositoryHistoryEntry:
      required:
      - author_name
      - date
      - id
      - is_active
      - message
      type: object
      properties:
        id:
          type: string
          description: Commit ID. For example GIT Hash.
          example: f4964f82ff9b6fcca9ed71519c05d6a29e0b1a00
        author_name:
          type: string
          description: Name of the user who committed to the repository.
          example: AUTOMIC/AUTOMIC
        date:
          type: string
          description: Date of the commit.
          format: date-time
          example: 2018-01-01T11:00:00Z
        message:
          type: string
          description: Commit message.
          example: Initial commit.
        is_active:
          type: boolean
          description: Is this commit the latest version imported into the automation
            engine?
          example: true
    OutRepositoryBranch:
      required:
      - active
      - branch_name
      type: object
      properties:
        branch_name:
          type: string
          description: Name of the branch.
          example: DEV-new-feature
        active:
          type: boolean
          description: if this is the active branch.
          example: true
    InCreateBranchParameters:
      required:
      - branch_name
      - commit_id
      type: object
      properties:
        commit_id:
          type: string
          description: The commit id to create the branch from
          example: b094726cc40cf5da7482b9c3f64844c166d9d177
        branch_name:
          type: string
          description: The name of the branch
          example: feature/add-new-job
    OutRepositoryCommit:
      required:
      - client
      - number_affected_objects
      - permission_missing_for_objects
      - status
      - version
      type: object
      properties:
        client:
          type: integer
          description: Client for which the repository was initialized.
          format: int32
          example: 100
        version:
          type: string
          description: Which version the commit created.
          example: "3"
        status:
          type: string
          description: Result status of the repository call.
          example: "SUCCESS, ERROR_PERMISSIONS etc."
        version_changes:
          type: array
          items:
            $ref: '#/components/schemas/OutRepoVersionEntry'
        permission_missing_for_objects:
          type: array
          items:
            type: string
            description: List of object names the user does not have write permission
              for.
            example: OBJ_A
        number_affected_objects:
          type: integer
          description: Amount of Automation Engine objects which were affected by
            the repository call.
          format: int32
          example: 100
        version_title:
          type: string
      description: Returns new version in repository.
    InCommitParameters:
      required:
      - message
      - objects
      type: object
      properties:
        message:
          type: string
          description: Commit message
          example: Changed Login Object
        objects:
          maxItems: 2147483647
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/InRepositoryObject'
      description: Encapsulates an automation engine objects saved into the repository.
    InRepositoryObject:
      required:
      - change_type
      - idnr
      - oh_name
      - oh_type
      type: object
      properties:
        idnr:
          type: integer
          description: The idnr of the object.
          format: int32
          example: 1234567
        oh_name:
          type: string
          description: The name of the object.
          example: SCRI.TESTSCRIPT1
        oh_type:
          type: string
          description: The type of the object.
          example: SCRI
        change_type:
          pattern: ^(ADD|DELETE|MODIFY|MOVE|RENAME)$
          type: string
          description: How the object changed since its last commit
          example: ADD
          enum:
          - ADD
          - DELETE
          - MODIFY
          - MOVE
          - RENAME
      description: List of uncommitted objects
    OutRepositoryRollback:
      required:
      - client
      - number_affected_objects
      - permission_missing_for_objects
      - status
      - version
      type: object
      properties:
        client:
          type: integer
          description: Client for which the repository was initialized.
          format: int32
          example: 100
        version:
          type: string
          description: Version to which is rolled back.
          example: "3"
        status:
          type: string
          description: Result status of the repository call.
          example: "SUCCESS, ERROR_PERMISSIONS etc."
        version_changes:
          type: array
          items:
            $ref: '#/components/schemas/OutRepoVersionEntry'
        permission_missing_for_objects:
          type: array
          items:
            type: string
            description: List of object names the user does not have write permission
              for.
            example: OBJ_A
        number_affected_objects:
          type: integer
          description: Amount of Automation Engine objects which were affected by
            the repository call.
          format: int32
          example: 100
        version_title:
          type: string
      description: Response that is sent when the automation engine is rolled back.
    OutRepositoryMerge:
      required:
      - status
      type: object
      properties:
        status:
          type: string
          description: Status of the merge.
          example: ok
        failure_reason:
          type: string
          description: Failure reason
          example: Invalid file paths etc
        conflicting_objects:
          type: array
          items:
            type: string
            description: List of objects with merge conflicts.
        added_objects:
          type: array
          items:
            type: string
            description: List of objects added by the merge.
        modified_objects:
          type: array
          items:
            type: string
            description: List of objects modified by the merge.
        removed_objects:
          type: array
          items:
            type: string
            description: List of objects removed by the merge.
        conflicting_deleted_objects:
          type: array
          items:
            type: string
            description: List of objects removed and edited.
      description: Result of a merge operation. Will contain added/changed/removed
        object names and possible merge conflicts.
    InHandleConflicts:
      required:
      - keep
      - object_name
      type: object
      properties:
        object_name:
          type: string
          description: Name of the conflicting Object.
          example: I.AM.IN.CONFLICT.SCRI
        keep:
          pattern: ^(ours|theirs|both)$
          type: string
          description: "Which version should be kept. ours= local, theirs= from other\
            \ branch, both= new Object is created, so both are available for cherry\
            \ picking."
          example: ours
      description: How should conflicts be handled.
    InMergeParameters:
      required:
      - branch_name
      - commit_automatically
      type: object
      properties:
        branch_name:
          type: string
          description: Which branch should be merged into active branch.
          example: dev
        commit_automatically:
          type: boolean
          description: Automatically commit when there are no conflicts or all are
            resolved.
          example: true
        handle_conflicts:
          type: array
          items:
            $ref: '#/components/schemas/InHandleConflicts'
    InScriptsBody:
      required:
      - script
      type: object
      properties:
        script:
          maxLength: 32000
          minLength: 0
          type: string
          description: The AE Script that should be executed.
          example: :PRINT 'Hello from REST API'
        queue:
          type: string
          description: Name of the queue in which the the script should run.
          example: CLIENT_QUEUE
    CustomAttribute:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    ResultInfo:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SearchResult'
        total:
          type: integer
          format: int32
        hasmore:
          type: boolean
        update_timestamp:
          type: integer
          format: int64
        indexing_in_progress:
          type: boolean
    SearchResult:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        sub_type:
          type: string
        platform:
          type: string
        id:
          type: string
        title:
          type: string
        archive_key1:
          type: string
        archive_key2:
          type: string
        agent:
          type: string
        login:
          type: string
        folder_path:
          type: string
        folder_id:
          type: string
        client:
          type: string
        is_inactive:
          type: string
        ert:
          type: string
        created_by:
          type: string
        modified_by:
          type: string
        mrt_method:
          type: string
        start_type:
          type: string
        internal_account:
          type: string
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttribute'
        references:
          type: array
          items:
            type: string
        creation_date:
          type: integer
          format: int64
        modified_date:
          type: integer
          format: int64
        last_used_date:
          type: integer
          format: int64
        link:
          type: boolean
        score:
          type: number
          format: float
        calendar_event_name:
          type: string
        calendar_event_c_type:
          type: string
        calendar_event_valid_from:
          type: integer
          format: int64
        calendar_event_valid_to:
          type: integer
          format: int64
        calendar_event_child_calendar_names:
          type: array
          items:
            type: string
    AgentFilter:
      required:
      - filter_identifier
      type: object
      description: Search in object's agent field (full-text).
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
    ArchiveKeysFilter:
      required:
      - filter_identifier
      type: object
      description: Filter for object's archive keys.
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
    BaseTypeMatchObjectTypeFilter:
      required:
      - filter_identifier
      type: object
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          values:
            type: array
            description: Array of filtered object types / platform / subtypes
            items:
              type: string
              description: Array of filtered object types / platform / subtypes
    CalendarEventFilter:
      required:
      - filter_identifier
      - query
      type: object
      description: Searches for events with the given event name that are valid on
        the given date.
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          query:
            type: string
            description: Name of the calendar event (may contain placeholder characters).
            example: SCRI.NEW.1
          valid_on_date:
            type: integer
            description: As unix timestamp in milliseconds.
            format: int64
          valid_from_min:
            type: integer
            description: Filter the validity lower bounds on valid_from (unix timestamp
              in milliseconds).
            format: int64
          valid_from_max:
            type: integer
            description: Filter the validity upper bounds on valid_from (unix timestamp
              in milliseconds).
            format: int64
          valid_to_min:
            type: integer
            description: Filter the validity lower bounds on validTo (unix timestamp
              in milliseconds).
            format: int64
          valid_to_max:
            type: integer
            description: Filter the validity upper bounds on validTo (unix timestamp
              in milliseconds).
            format: int64
          active_on_days_from:
            type: integer
            description: As unix timestamp in milliseconds.
            format: int64
          active_on_days_to:
            type: integer
            description: As unix timestamp in milliseconds.
            format: int64
          event_types:
            type: array
            description: "Y=Yearly, M=Monthly, W=Weekly, S=Static, R=Roll, G=Group,\
              \ O=Old fashioned CALE"
            items:
              type: string
              description: "Y=Yearly, M=Monthly, W=Weekly, S=Static, R=Roll, G=Group,\
                \ O=Old fashioned CALE"
              enum:
              - "Y"
              - M
              - W
              - S
              - R
              - G
              - O
            enum:
            - "Y"
            - M
            - W
            - S
            - R
            - G
            - O
    ClientFilter:
      required:
      - filter_identifier
      type: object
      description: Can be used to also search in client 0.
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          include_client_zero:
            type: boolean
            description: Set to "true" if also client 0 should be searched.
    DocumentationFilter:
      required:
      - filter_identifier
      type: object
      description: Search in object's documentation(full-text).
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
    GranularityFilter:
      required:
      - filter_identifier
      type: object
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          granularity:
            type: string
            enum:
            - OBJECT
            - KEYWORD
    InSearchBody:
      required:
      - filters
      type: object
      properties:
        start_at:
          type: integer
          description: Paging start from index.
          format: int32
        max_results:
          type: integer
          description: The maximum number of results the query should return.
          format: int32
          example: 20
        update_index:
          type: boolean
          description: Specifies wheter an index update should occur before performing
            the search
          example: false
        filters:
          type: array
          items:
            $ref: '#/components/schemas/SearchFilter'
        sort_columns:
          $ref: '#/components/schemas/InSortColumns'
    InSortColumns:
      type: object
      properties:
        name:
          type: boolean
        type:
          type: boolean
        sub_type:
          type: boolean
        platform:
          type: boolean
        title:
          type: boolean
        archive_key1:
          type: boolean
        archive_key2:
          type: boolean
        folder_path:
          type: boolean
        modified_date:
          type: boolean
        last_used_date:
          type: boolean
        creation_date:
          type: boolean
        calendar_event_name:
          type: boolean
        calendar_event_ctype:
          type: boolean
        calendar_event_valid_from:
          type: boolean
        calendar_event_valid_to:
          type: boolean
      description: "Determines sort order of result columns. Pass <i>true</i> to sort\
        \ ascending, <i>false</i> to sort descending."
    LocationFilter:
      required:
      - filter_identifier
      - location
      type: object
      description: Finds objects by their folder location.
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          location:
            type: string
            description: "The path to which the search should be restricted, using\
              \ \\\\ as separator"
            example: \\
          include_links:
            type: boolean
            description: Whether links should also be included in the search.
            example: false
          include_subfolders:
            type: boolean
            description: Whether subfolders of path should be included in the search.
            example: false
    LoginFilter:
      required:
      - filter_identifier
      type: object
      description: Search in object's login field (full-text).
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
    ObjectContentsFilter:
      required:
      - filter_identifier
      type: object
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          query:
            type: string
            description: The search string.
    ObjectIdFilter:
      required:
      - filter_identifier
      - object_id
      type: object
      description: Searches for an object with the given id.
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          object_id:
            type: integer
            format: int32
    ObjectNameFilter:
      required:
      - filter_identifier
      - object_name
      type: object
      description: "Searches for object names, also supports placeholder signs."
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          object_name:
            type: string
            description: The object name to look for including ? and * placeholder
              signs.
    ObjectPlatformFilter:
      required:
      - filter_identifier
      type: object
      description: Find objects by the attribute platform.
      allOf:
      - $ref: '#/components/schemas/BaseTypeMatchObjectTypeFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          platforms:
            type: array
            writeOnly: true
            items:
              type: string
    ObjectSubTypeFilter:
      required:
      - filter_identifier
      type: object
      description: Find objects by the attribute subtype.
      allOf:
      - $ref: '#/components/schemas/BaseTypeMatchObjectTypeFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          object_sub_types:
            type: array
            writeOnly: true
            items:
              type: string
    ObjectTitleFilter:
      required:
      - filter_identifier
      type: object
      description: Search in object titles.
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
    ObjectTypeFilter:
      required:
      - filter_identifier
      type: object
      description: Finds objects by the attribute object type.
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          values:
            type: array
            description: Array of filtered object types / platform / subtypes
            items:
              type: string
              description: Array of filtered object types / platform / subtypes
          object_types:
            type: array
            writeOnly: true
            items:
              type: string
    ProcessSheetFilter:
      required:
      - filter_identifier
      type: object
      description: Search in scripts of the process sheet (full-text).
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
    SearchFilter:
      required:
      - filter_identifier
      type: object
      properties:
        filter_identifier:
          type: string
          description: Identifier of filter to be used.
          example: object_name
          enum:
          - identifier
          - object_name
          - location
          - client
          - calendar_event
          - object_id
          - time_frame
          - granularity
          - variable_key
          - archive_key
          - variable_value
          - title
          - process
          - documentation
          - object_type
          - platform
          - object_sub_type
          - "agent,login"
      description: List of filters.
    TimeFrameFilter:
      required:
      - filter_identifier
      - type
      type: object
      description: Searches for objects that were created create/modified/used within
        the given time frame.
      allOf:
      - $ref: '#/components/schemas/SearchFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          type:
            type: string
            enum:
            - CREATED
            - MODIFIED
            - USED
          from:
            type: integer
            description: The start of the timeframe. Either "from" or "until" must
              be filled.
            format: int64
          until:
            type: integer
            description: The end of the timeframe. Either "from" or "until" must be
              filled.
            format: int64
    VaraKeyFilter:
      required:
      - filter_identifier
      type: object
      description: Searches for variable keys inside of STATIC VARA objects.
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
    VaraValueFilter:
      required:
      - filter_identifier
      type: object
      description: Searches for variable values inside of STATIC VARA objects.
      allOf:
      - $ref: '#/components/schemas/ObjectContentsFilter'
      - type: object
        properties:
          filter_identifier:
            type: string
            description: Identifier of filter to be used.
            example: object_name
            enum:
            - identifier
            - object_name
            - location
            - client
            - calendar_event
            - object_id
            - time_frame
            - granularity
            - variable_key
            - archive_key
            - variable_value
            - title
            - process
            - documentation
            - object_type
            - platform
            - object_sub_type
            - "agent,login"
          all_columns:
            type: boolean
          type:
            type: string
            enum:
            - ANY
            - TEXT
            - NUMBER
            - DATE
            - TIME
            - DATETIME
    OutHealthCheck:
      type: object
      properties:
        status:
          type: string
          description: Indicates whether this system is active enough.
          example: UP
          enum:
          - UP
          - DOWN
        count_active_executions:
          type: integer
          description: Indicates the number of all active tasks in the system.
          format: int32
          example: 1
        pwp:
          $ref: '#/components/schemas/OutHealthProcessType'
        wp:
          $ref: '#/components/schemas/OutHealthProcessType'
        jwp:
          $ref: '#/components/schemas/OutHealthProcessType'
        jcp:
          $ref: '#/components/schemas/OutHealthProcessType'
        rest:
          $ref: '#/components/schemas/OutHealthProcessType'
        cp:
          $ref: '#/components/schemas/OutHealthProcessType'
    OutHealthInstances:
      type: object
      properties:
        name:
          type: string
          description: Indicates the name of the server/process.
          example: AUTOMIC#WP001
        count_of_connections:
          type: integer
          description: Indicates the number of connections from this server.
          format: int32
          example: 1
        last_life_sign:
          type: string
          description: Indicates the date of last life of this server.
          format: date-time
          example: 2015-04-15T06:38:59Z
      description: Indicates all processes unavailable in the system.
    OutHealthProcessType:
      type: object
      properties:
        status:
          type: string
          description: Indicates the overall health of the communication or work processes.
          example: UP
          enum:
          - UP
          - DOWN
        instances_running:
          type: integer
          description: Indicates the presence of a PWP in the system.
          format: int32
          example: 1
        available:
          type: array
          description: Indicates all processes available in the system.
          items:
            $ref: '#/components/schemas/OutHealthInstances'
        unavailable:
          type: array
          description: Indicates all processes unavailable in the system.
          items:
            $ref: '#/components/schemas/OutHealthInstances'
      description: Indicates the presence of a CP in the system.
    InAgentPacksBody:
      required:
      - platform
      type: object
      properties:
        platform:
          type: string
          description: Platform of the agent package.
          example: UNIX
          enum:
          - RA
          - SQL
          - WINDOWS
          - UNIX
        name:
          type: string
          description: Name of the agent. The name of the host is used if missing.
            Required if authentication is set to LOCAL_REMOTE
          example: AGENT01
        operating_system:
          type: string
          description: "Operating system name, required if the platform is Unix."
          example: LINUX
          enum:
          - WINDOWS
          - AIX
          - HPUX
          - LINUX
          - SOLARIS
          - ZLINUX
        operating_system_architecture:
          type: string
          description: "Operating system architecture, required if the platform is\
            \ Unix or Windows."
          example: X64
          enum:
          - IA64
          - POWERPC
          - POWERPC64
          - POWERPC64LE
          - SPARC
          - SPARC64
          - X64
          - X86
          - ZSERIES
          - ZSERIES64
        config_update:
          type: string
          description: Optional changes applied to the configuration file of the agent.
          example: "[TCP/IP]\nport=2301\n\n[GLOBAL]\nfileProcessingMaxDepth=1\nfileProcessingTimeout=60"
        service_manager:
          $ref: '#/components/schemas/InAgentPacksServiceManager'
      description: Body of a REST request to download a pre-configured agent.
    InAgentPacksServiceManager:
      required:
      - operating_system
      - operating_system_architecture
      type: object
      properties:
        operating_system:
          type: string
          description: Operating system name of the service manager.
          example: LINUX
          enum:
          - WINDOWS
          - AIX
          - HPUX
          - LINUX
          - SOLARIS
          - ZLINUX
        operating_system_architecture:
          type: string
          description: Operating system architecture of the service manager.
          example: X64
          enum:
          - IA64
          - POWERPC
          - POWERPC64
          - POWERPC64LE
          - SPARC
          - SPARC64
          - X64
          - X86
          - ZSERIES
          - ZSERIES64
        config_update:
          type: string
          description: Optional changes applied to the configuration file of the service
            manager.
          example: "[GLOBAL]\nport=4455"
      description: "Defines the service manager configuration, if missing no service\
        \ manager is included in the agent pack."
    OutAgentGroup:
      required:
      - client
      - mode
      - name
      - parallel_tasks
      - platform
      type: object
      properties:
        name:
          type: string
          description: Name of the agentgroup.
          example: AGENTS.WINDOWS
        client:
          type: integer
          description: Client number which contains the agent group.
          format: int32
          example: 0
        platform:
          type: string
          description: Platform which the agents are assigned to.
          example: WINDOWS
        mode:
          type: string
          description: "Agent selection mode: A - Any, X - All, F - First, N - Next,\
            \ L - Load dependent"
          example: X
          enum:
          - A
          - X
          - F
          - "N"
          - L
        parallel_tasks:
          type: integer
          description: Number of tasks that are allowed to be parallel in mode X (All)
          format: int32
          example: 100
    OutAgentGroupList:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutAgentGroup'
    InCreateAgentBody:
      required:
      - name
      - template
      type: object
      properties:
        name:
          type: string
          description: The name of the agent.
          example: WIN01
        template:
          maxLength: 32
          minLength: 0
          type: string
          description: The name of the template entry in UC_OBJECT_TEMPLATE.
          example: <WIN>
    OutAgent:
      required:
      - active
      - authenticated
      - hardware
      - jcl_variant
      - name
      - platform
      - port
      - software
      type: object
      properties:
        active:
          type: boolean
          description: <b>True</b> if the Agent is running.
          example: true
        name:
          type: string
          description: Name of the Agent.
          example: WIN01
        jcl_variant:
          type: string
          description: The JCL (Job Control Language) variant.
          example: WINDOWS
        platform:
          type: string
          description: The type (HostAttrType) of the agent.
          example: WINDOWS
        authenticated:
          type: boolean
          description: "<b>True</b> if the agent is authenticated, false otherwise."
          example: true
        version:
          type: string
          description: The version of the operating system.
          example: 12.3.0+low.build.1100
        hardware:
          type: string
          description: "The computer's hardware information (i.e. system type, number\
            \ of processors, processor type)."
          example: x86/2/64
        ip_address:
          type: string
          description: The Agent's TCP/IP address.
          example: 10.132.185.65
        port:
          type: integer
          description: The Agent's port number.
          format: int32
          example: 2302
        software:
          type: string
          description: Computer's operating system.
          example: WinNT
        workload_max_job:
          type: integer
          description: "The Agent's max job resources. range: (-1:unlimited) to 1000"
          format: int32
          example: 100
        workload_max_f_t:
          type: integer
          description: "The Agent's max file transfer resources. range: (-1:unlimited)\
            \ to 1000"
          format: int32
          example: 100
        tls:
          type: boolean
          description: "<b>True</b> if the agent is a TLS-Agent, false otherwise."
          example: true
        gateway:
          type: string
          description: "The name of the TLS-Gateway, which the Agent uses as CP Port."
          example: UCTLSGTW01
        linked:
          type: boolean
    OutAuthenticationPackage:
      type: object
      properties:
        data:
          type: string
          description: Content of the initial package that an agent needs in order
            to start.
      description: Response with agent authentication if LOCAL or LOCAL_REMOTE is
        set in UC_AS_SETTINGS.
    OutAgentList:
      required:
      - data
      - hasmore
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutAgent'
        hasmore:
          type: boolean
          description: Indicates if there are more results than currently returned.
          example: false
    InRenameAgentBody:
      required:
      - new_name
      type: object
      properties:
        new_name:
          maxLength: 32
          minLength: 0
          type: string
          description: The new name of the agent.
          example: NEW_WIN_AGENT
        title:
          maxLength: 255
          minLength: 0
          type: string
          description: "Optional: title of the agent object."
          example: New title
    OutCertificate:
      required:
      - expiration_date
      - server_name
      - subject_distinguished_name
      type: object
      properties:
        expiration_date:
          type: string
          description: Certificate's expiration point in time
          format: date-time
        subject_distinguished_name:
          type: string
          description: Distinguished name (DN)
        server_name:
          type: string
          description: JCP Server name
      description: Lists data for tls certificates including expiration dates.
    OutCertificatesList:
      required:
      - certificate_list
      type: object
      properties:
        certificate_list:
          type: array
          description: Lists data for tls certificates including expiration dates.
          items:
            $ref: '#/components/schemas/OutCertificate'
    OutClient:
      required:
      - client
      - client_active
      - mib_monitor
      - number_of_activities
      - number_of_objects
      - number_of_users
      - priority
      - task_priority
      type: object
      properties:
        client:
          type: integer
          description: Number of the client.
          format: int32
          example: 100
        client_active:
          type: boolean
          description: <b>True</b> if this client is currently active for automatic
            processing
          example: true
        title:
          type: string
          description: Title specified in the Client object.
          example: Test client
        timezone:
          type: string
          description: Time zone valid in this client.
          example: TZ.CET
        number_of_objects:
          type: integer
          description: Number of objects created in the client.
          format: int32
          example: 1000
        number_of_activities:
          type: integer
          description: Number of tasks currently being executed.
          format: int32
          example: 100
        number_of_users:
          type: integer
          description: Number of users who are currently logged on.
          format: int32
          example: 10
        mib_monitor:
          type: boolean
          description: <b>True</b> if this client is subject to SNMP monitoring.
          example: false
        mib_info:
          type: string
          description: MIB information of the client.
        priority:
          type: integer
          description: Priority of the client specified in the variable UC_CLIENT_SETTINGS
            with the key CLIENT_PRIORITY.
          format: int32
          example: 200
        task_priority:
          type: integer
          description: Priority of the client's tasks specified in the variable UC_CLIENT_SETTINGS
            with the TASK_PRIORITY key.
          format: int32
          example: 200
    OutClientList:
      required:
      - data
      - hasmore
      - total
      type: object
      properties:
        total:
          type: integer
          format: int32
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutClient'
        hasmore:
          type: boolean
          description: Indicates if there are more results than currently returned.
          example: false
    OutRASolution:
      required:
      - created_by
      - creation_time
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the RA solution.
          example: FTPAGENT
        title:
          type: string
          description: Title of the RA solution.
          example: RA FTP agent
        version:
          type: string
          description: Version of the RA solution.
          example: 4.5.1-develop-SNAPSHOT+build.508
        creation_time:
          type: string
          description: RA solution creation time.
          format: date-time
          example: 2019-11-17T01:02:03Z
        modification_time:
          type: string
          description: RA solution last modification time.
          format: date-time
          example: 2020-04-27T14:15:16Z
        created_by:
          type: string
          description: User which created RA solution.
          example: THEUSER/DEPARTMENT
        modified_by:
          type: string
          description: User which last time modified RA solution.
          example: ADMIN/MASTER
        archive_key1:
          type: string
          description: ArchiveKey1
          example: key1
        archive_key2:
          type: string
          description: ArchiveKey2
          example: key2
        signature:
          type: string
          description: Signature
          example: Issued to:... Issued by:... Valid from:... Valid to:...
    InRASolutionBody:
      required:
      - solution
      type: object
      properties:
        solution:
          type: string
          description: Encoded Base64 RA solution .jar binary.
        checksum:
          type: string
          description: Hash value of the RA solution. Optional
        algorithm:
          type: string
          description: Hash algorithm which is used to compute @checksum. Default
            is MD5.
          enum:
          - MD5
          - SHA-256
          - SHA-512
        ignore_signature:
          type: boolean
          description: Skip signature check of RA solution. False by default
    OutRASolutionsList:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OutRASolution'
    OutSystemFeature:
      required:
      - available
      - identifier
      type: object
      properties:
        identifier:
          type: string
          description: The System Features identifier
          example: SAMPLE_FEATURE
        available:
          type: boolean
          description: Indicates if the Feature is available or not
    OutSystemFeatureList:
      required:
      - features
      - total
      type: object
      properties:
        features:
          type: array
          items:
            $ref: '#/components/schemas/OutSystemFeature'
        total:
          type: integer
          description: Total number of features.
          format: int32
          example: 1
    OutTelemetryProduct:
      required:
      - description
      - name
      type: object
      properties:
        name:
          type: string
          description: The telemetry products name
          example: AWA
        description:
          type: string
          description: The telemetry products description
          example: CA Automic Workload Automation
    OutTelemetryProductList:
      required:
      - products
      type: object
      properties:
        products:
          type: array
          items:
            $ref: '#/components/schemas/OutTelemetryProduct'
    NamedResponse:
      type: object
      additionalProperties:
        type: string
  examples:
    file_transferOut:
      value: "{\"total\":1,\"data\":{\"jobf\":{\"metadata\":{\"version\":\"21.0.0\"\
        },\"general_attributes\":{\"minimum_ae_version\":\"11.2\",\"auto_deactivation\"\
        :\"A\",\"platform\":\"UNIX\",\"max_parallel_action\":\"1\",\"mrt_time\":\"\
        000000\",\"name\":\"FILE_TRANSFER\",\"type\":\"JOBF\",\"inherit_output_filter\"\
        :\"N\",\"queue\":\"CLIENT_QUEUE\"},\"file_transfer_attributes\":{\"erase_source_files\"\
        :\"1\",\"destination_path\":\"DstFile.txt\",\"source_path\":\"SrcFile.txt\"\
        ,\"destination_agent\":\"UNIX01\",\"source_agent\":\"WIN01\",\"destination_login\"\
        :\"LOGIN.UNIX01\",\"source_login\":\"LOGIN.WIN01\",\"max_parallel_ft\":\"\
        1\",\"allow_overwrite\":\"0\",\"repeat_type\":\"S\",\"additional_attributes\"\
        :\"1=''2=''\",\"text_type\":\"0\"},\"rollback_definitions\":{}}},\"path\"\
        :\"\",\"client\":100,\"hasmore\":false}"
    simple_scriptOut:
      value: "{\"total\":1,\"data\":{\"scri\":{\"metadata\":{\"version\":\"21.0.0\"\
        },\"general_attributes\":{\"minimum_ae_version\":\"11.2\",\"auto_deactivation\"\
        :\"A\",\"ert\":\"1\",\"max_parallel_action\":\"1\",\"mrt_time\":\"000000\"\
        ,\"name\":\"SIMPLE_SCRIPT\",\"type\":\"SCRI\",\"inherit_output_filter\":\"\
        N\",\"queue\":\"CLIENT_QUEUE\"},\"scripts\":{\"process\":[\":DEFINE &FILE#,\
        \ string\",\":SET &FILE# = \\\"temp.txt\\\"\",\"\",\":DEFINE &STRING#, string\"\
        ,\"\",\":DEFINE &SIGNED#, signed\",\"\",\":DEFINE &UNSIGNED#, unsigned\",\"\
        \",\":DEFINE &FLOAT#, float\",\"\",\":SET &STRING#= \\\"1234abc\\\"\",\":SET\
        \ &SIGNED#= -5\",\":SET &UNSIGNED#= 24\",\":SET &FLOAT#= -0.50\"]},\"script_attributes\"\
        :{},\"rollback_definitions\":{}}},\"path\":\"EXAMPLES/SCRIPTS\",\"client\"\
        :100,\"hasmore\":false}"
    standard_workflowOut:
      value: "{\"total\":1,\"data\":{\"jobp\":{\"metadata\":{\"version\":\"21.0.0\"\
        },\"general_attributes\":{\"minimum_ae_version\":\"11.2\",\"auto_deactivation\"\
        :\"F\",\"workflow_children\":\"5\",\"max_parallel_action\":\"1\",\"mrt_time\"\
        :\"000000\",\"name\":\"WORKFLOW\",\"type\":\"JOBP\",\"inherit_output_filter\"\
        :\"N\",\"queue\":\"CLIENT_QUEUE\"},\"workflow_attributes\":{\"reuse_agent_group\"\
        :\"1\"},\"workflow_definitions\":[{\"active\":\"1\",\"childflags\":\"0000000000000000\"\
        ,\"column\":\"4\",\"line_number\":\"5\",\"mrt_time\":\"000000\",\"object_name\"\
        :\"END\",\"object_type\":\"<END>\",\"predecessors\":\"2\",\"row\":\"2\",\"\
        precondition_error_action\":\"H\"},{\"active\":\"1\",\"childflags\":\"0100000000000000\"\
        ,\"column\":\"3\",\"line_number\":\"4\",\"mrt_time\":\"000000\",\"object_name\"\
        :\"ADVANCED_SCRIPT\",\"object_type\":\"SCRI\",\"predecessors\":\"1\",\"has_preconditions\"\
        :\"1\",\"rollback_enabled\":\"1\",\"row\":\"1\",\"precondition_error_action\"\
        :\"H\"},{\"active\":\"1\",\"childflags\":\"0000000000000000\",\"column\":\"\
        1\",\"line_number\":\"1\",\"mrt_time\":\"000000\",\"object_name\":\"START\"\
        ,\"object_type\":\"<START>\",\"row\":\"2\",\"precondition_error_action\":\"\
        S\"},{\"active\":\"1\",\"childflags\":\"0000000000000000\",\"column\":\"3\"\
        ,\"line_number\":\"3\",\"mrt_time\":\"000000\",\"object_name\":\"WINDOWS_JOB\"\
        ,\"object_type\":\"JOBS\",\"predecessors\":\"1\",\"rollback_enabled\":\"1\"\
        ,\"row\":\"2\",\"precondition_error_action\":\"S\"},{\"active\":\"1\",\"childflags\"\
        :\"0000000000000000\",\"column\":\"2\",\"line_number\":\"2\",\"mrt_time\"\
        :\"000000\",\"object_name\":\"SIMPLE_SCRIPT\",\"object_type\":\"SCRI\",\"\
        predecessors\":\"1\",\"rollback_enabled\":\"1\",\"row\":\"2\",\"precondition_error_action\"\
        :\"H\"}],\"line_conditions\":[{\"workflow_line_number\":\"2\",\"line_number\"\
        :\"1\",\"predecessor_line_number\":\"1\"},{\"workflow_line_number\":\"3\"\
        ,\"line_number\":\"1\",\"predecessor_line_number\":\"2\"},{\"workflow_line_number\"\
        :\"4\",\"line_number\":\"1\",\"predecessor_line_number\":\"2\"},{\"workflow_line_number\"\
        :\"5\",\"line_number\":\"1\",\"predecessor_line_number\":\"4\"},{\"workflow_line_number\"\
        :\"5\",\"line_number\":\"2\",\"predecessor_line_number\":\"3\"}],\"conditions\"\
        :[{\"active\":\"1\",\"name\":\"CHECK FILE\",\"workflow_line_number\":\"4\"\
        ,\"condition_line_number\":\"1\",\"execution_time\":\"1\",\"type\":\"C\"},{\"\
        active\":\"1\",\"name\":\"RUN TASK\",\"workflow_line_number\":\"4\",\"condition_line_number\"\
        :\"2\",\"execution_time\":\"1\",\"occurrence\":\"1\",\"type\":\"A\"},{\"active\"\
        :\"1\",\"name\":\"CHECK FILE\",\"workflow_line_number\":\"4\",\"condition_line_number\"\
        :\"3\",\"execution_time\":\"1\",\"occurrence\":\"1\",\"type\":\"F\"}],\"condition_values\"\
        :[{\"condition_link_line_number\":\"1\",\"workflow_line_number\":\"4\",\"\
        execution_time\":\"1\",\"type\":\"V\",\"value\":\"LOGIN.WIN01\",\"variable\"\
        :\"XC_P04\"},{\"condition_link_line_number\":\"1\",\"workflow_line_number\"\
        :\"4\",\"execution_time\":\"1\",\"type\":\"V\",\"value\":\"##911002\",\"variable\"\
        :\"XC_P03\"},{\"condition_link_line_number\":\"1\",\"workflow_line_number\"\
        :\"4\",\"execution_time\":\"1\",\"type\":\"V\",\"value\":\"log.txt\",\"variable\"\
        :\"XC_P02\"},{\"condition_link_line_number\":\"1\",\"workflow_line_number\"\
        :\"4\",\"execution_time\":\"1\",\"type\":\"V\",\"value\":\"WIN01\",\"variable\"\
        :\"XC_P01\"}],\"rollback_definitions\":{}}},\"path\":\"EXAMPLES/WORKFLOWS\"\
        ,\"client\":100,\"hasmore\":false}"
    static_variableOut:
      value: "{\"total\":1,\"data\":{\"vara\":{\"metadata\":{\"version\":\"21.0.0\"\
        },\"general_attributes\":{\"minimum_ae_version\":\"11.2\",\"name\":\"STATIC_VARIABLE\"\
        ,\"type\":\"VARA\",\"sub_type\":\"STATIC\"},\"variable_definitions\":{\"column_count\"\
        :\"5\",\"on_not_found\":\"I\",\"sort_order\":\"0\",\"type\":\"STATIC\",\"\
        data_type\":\"C\",\"validity_range\":\"FREI\"},\"static_values\":[{\"client\"\
        :\"100\",\"value1\":\"Asia\",\"value2\":\"Africa\",\"value3\":\"Europe\",\"\
        value4\":\"North America\",\"value5\":\"South America\",\"validity_range\"\
        :\"FREI\",\"key\":\"Continents\"},{\"client\":\"100\",\"value1\":\"Mars\"\
        ,\"value2\":\"Earth\",\"value3\":\"Mercury\",\"value4\":\"Venus\",\"value5\"\
        :\"Jupiter\",\"validity_range\":\"FREI\",\"key\":\"Planets\"}]}},\"path\"\
        :\"EXAMPLES/VARAS\",\"client\":100,\"hasmore\":false}"
    unix_jobOut:
      value: "{\"total\":1,\"data\":{\"jobs\":{\"metadata\":{\"version\":\"21.0.0\"\
        },\"general_attributes\":{\"minimum_ae_version\":\"11.2\",\"auto_deactivation\"\
        :\"A\",\"platform\":\"UNIX\",\"max_parallel_action\":\"1\",\"mrt_time\":\"\
        000000\",\"name\":\"UNIX_JOB\",\"type\":\"JOBS\",\"has_object_variables\"\
        :\"1\",\"inherit_output_filter\":\"N\",\"queue\":\"CLIENT_QUEUE\"},\"scripts\"\
        :[{\"process\":[\"sleep 60\",\"exit\"]},{\"pre_process\":\"ls\"}],\"job_attributes\"\
        :{\"platform\":\"UNIX\",\"agent\":\"UNIX01\",\"login\":\"LOGIN.UNIX01\",\"\
        job_report_path\":\"2\",\"priority\":\"0\",\"unix_shell\":\"bash\",\"unix_shell_options\"\
        :\"\",\"unix_type\":\"\",\"unix_cmd\":\"\"},\"object_variables\":{\"value\"\
        :\"\\\"bin/lib\\\"\",\"name\":\"&MY_DIRECTORY#\"},\"rollback_definitions\"\
        :{}}},\"path\":\"\",\"client\":100,\"hasmore\":false}"
    windows_jobOut:
      value: "{\"total\":1,\"data\":{\"jobs\":{\"metadata\":{\"version\":\"21.0.0\"\
        },\"general_attributes\":{\"minimum_ae_version\":\"11.2\",\"auto_deactivation\"\
        :\"A\",\"platform\":\"WINDOWS\",\"max_parallel_action\":\"1\",\"mrt_time\"\
        :\"000000\",\"name\":\"WINDOWS_JOB\",\"type\":\"JOBS\",\"inherit_output_filter\"\
        :\"N\",\"queue\":\"CLIENT_QUEUE\"},\"scripts\":[{\"process\":[\" C:\\\\Automic\\\
        \\Automation.Platform\\\\Agents\\\\Windows\\\\example\\\\ucybtx64c.exe -W60\"\
        ,\"dir C:\\\\temp > C:\\\\temp\\\\contents.txt\",\"@set retcode=%errorlevel%\"\
        ,\"@if NOT %ERRORLEVEL% == 0 goto:retcode\"]},{\"pre_process\":\"dir\"}],\"\
        job_attributes\":{\"platform\":\"WINDOWS\",\"agent\":\"WIN01\",\"login\":\"\
        LOGIN.WIN01\",\"job_report_path\":\"2\",\"win_work_dir\":\"c:\\\\\",\"win_typ\"\
        :\"0\",\"win_view\":\"0\",\"win_logon_as_batch\":\"0\",\"win_show_at_desktop\"\
        :\"0\",\"win_report_by_script\":\"0\",\"job_object\":\"\",\"win_cmd\":\"\"\
        },\"rollback_definitions\":{}}},\"path\":\"EXAMPLES/JOBS\",\"client\":100,\"\
        hasmore\":false}"
    example-once-releaseIn:
      value: "{\"object_name\":\"JOBS.WIN.TEST\",\"alias\":\"ALIAS_PROMPT_ONCE\",\"\
        queue\":\"TEST_QUEUE\",\"execution_option\":\"once\",\"timezone\":\"TZ.MEZ\"\
        ,\"once\":{\"wait_for_manual_release\":\"true\"},\"inputs\":{\"TEXTFIELD1#\"\
        :\"test\",\"CHECKGROUP1#\":\"AE/AE\"}}"
    example-once-timeIn:
      value: "{\"object_name\":\"JOBS.WIN.TEST\",\"alias\":\"ALIAS_PROMPT_ONCE\",\"\
        queue\":\"TEST_QUEUE\",\"execution_option\":\"once\",\"timezone\":\"TZ.MEZ\"\
        ,\"once\":{\"execution_date_time\":\"2018-02-27T10:00:00Z\",\"wait_for_manual_release\"\
        :\"false\",\"use_logical_time\":\"2018-02-27T10:00:00Z\"},\"inputs\":{\"TEXTFIELD1#\"\
        :\"test\",\"CHECKGROUP1#\":\"AE/AE\"}}"
    example-recurring-calendar-intervalIn:
      value: "{\"object_name\":\"JOBS.WIN.TEST\",\"execution_option\":\"recurring\"\
        ,\"alias\":\"RECURRING_CALE_INTERVAL\",\"timezone\":\"TZ.CET\",\"queue\":\"\
        TEST_QUEUE\",\"recurring\":{\"period_description\":\"Period desc\",\"start_date\"\
        :\"2018-04-10\",\"end_date\":\"2018-04-30\",\"execute_interval\":\"P3D\",\"\
        allow_one_overlap\":\"false\",\"between_start\":\"00:00\",\"between_end\"\
        :\"23:59\",\"adjust_start_time\":\"false\",\"execute_calendar_match\":\"one\"\
        ,\"execute_calendar_list\":[{\"calendar\":\"UC_HOLIDAYS.CH\",\"event\":\"\
        CHRISTMAS DAY\"},{\"calendar\":\"UC_HOLIDAYS.A\",\"event\":\"ALL SAINTS\"\
        }]},\"inputs\":{\"TEXTFIELD1#\":\"test\",\"CHECKGROUP1#\":\"AE/AE\"}}"
    example-recurring-gapIn:
      value: "{\"object_name\":\"JOBS.WIN.TEST\",\"execution_option\":\"recurring\"\
        ,\"alias\":\"RECURRING_GAP_ENDAFTEREXECUTIONS\",\"timezone\":\"TZ.CET\",\"\
        queue\":\"TEST_QUEUE\",\"recurring\":{\"period_description\":\"Period desc\"\
        ,\"start_date\":\"2018-04-13\",\"end_after_executions\":5,\"execute_after\"\
        :\"PT5M\"},\"inputs\":{\"TEXTFIELD1#\":\"test\",\"CHECKGROUP1#\":\"AE/AE\"\
        }}"
    example-recurring-weeklyIn:
      value: "{\"object_name\":\"JOBS.WIN.TEST\",\"execution_option\":\"recurring\"\
        ,\"alias\":\"RECURRING_EXECUTEAT_WEEKLY\",\"timezone\":\"TZ.CET\",\"queue\"\
        :\"TEST_QUEUE\",\"recurring\":{\"period_description\":\"Period desc\",\"start_date\"\
        :\"2018-04-13\",\"end_date\":\"2018-04-30\",\"execute_at\":\"12:00\",\"allow_one_overlap\"\
        :\"false\",\"between_start\":\"00:00\",\"between_end\":\"23:59\",\"adjust_start_time\"\
        :\"false\",\"execute_weekly\":[\"mon\",\"wed\",\"thu\",\"sun\"]},\"inputs\"\
        :{\"TEXTFIELD1#\":\"test\",\"CHECKGROUP1#\":\"AE/AE\"}}"
    example-with-json-inputIn:
      value: "{\"object_name\":\"SCRI.EXECUTE.WITH.JSON.INPUT.JSON\",\"execution_option\"\
        :\"execute\",\"inputs\":{\"&SERVERS#|json\":{\"servers\":[{\"name\":\"web\"\
        ,\"online\":true},{\"name\":\"db\",\"online\":false}]}}}"