Using the REST API

This article describes how to use the Representational State Transfer Application Programming Interface (REST API) available for
CA Endevor
, and provides usage examples.
ce18
This article describes how to use the Representational State Transfer Application Programming Interface (REST API) available for
CA Endevor
, and provides usage examples.
For information on how to install the
CA Endevor
REST API, see Install and Set Up
CA Endevor
Web Services.
2
Web Services supports two methods for accessing the
CA Endevor
API. The SOAP method is built using the Axis2 framework. The RESTful method is an extension of the SOAP method, but is simpler to use. Both methods support most of the
CA Endevor
actions. For more information about the SOAP method, see SOAP Clients.
You can build a client program using the RESTful method as an alternative to the SOAP-based method.
The RESTful API provides the Representational State Transfer (REST) architectural style of web services, which uses HTTP 1.1 and Uniform Resource Identifiers (URI). This architectural style provides a simpler, more lightweight API, scalability, improved performance, and easier adoption due to a better known distributed server-client application development model based on the HTTP protocol.
The RESTful API can process the following requests:
  • Requests for information about repositories, which are the available configurations (
    CA Endevor
    instances) on the mainframe. Repository actions let you list the following information about the available instances of
    CA Endevor
    ® SCM:
    • List All Configurations
    • List Parameters of a Configuration
  • Requests to process supported
    CA Endevor
    REST API actions.
Supported Actions
The
CA Endevor
REST API supports the following categories of actions:
  • Element Actions
    Processes actions that relate to Elements.
  • Inventory (List) Actions
    Processes actions that relate to inventories. These actions include the ability to list Systems, Subsystems, Types, and Elements for an inventory location.
  • Submit SCL
    Processes actions that submit SCL statements.
  • Package Actions
    Processes that relate to Packages.
  • Validate Fingerprint
    The RESTful API lets you compare the fingerprint entry in an element with the fingerprint of that element in
    CA Endevor
    .
Example Use Cases
The  REST API for
CA Endevor
can be used in the following ways, depending on your role:
Package Actions
  • Automated Pipeline
    Drive continuous integration and continuous delivery processes from tools such as Jenkins Pipeline, CA Continuous Delivery Director, and CA Continuous Delivery Automation, where shell scripts drive packaging or lifecycle operations on individual programs through CA Brightside.
  • Developer Automated Workflow (Downstream Events)
    Automatically package changes by Change Control Identifier (CCID) upon closure of an Agile user story or defect.
    Enterprise Packaging: Merge changes in multiple source control systems (for example, CA Harvest SCM or Git) with
    CA Endevor
    .
  • Developer
    Facilitate interaction with
    CA Endevor
    through IDE plugins such as Eclipse, CA Development Environment for z Systems, IBM Developer for z Systems, Eclipse Che, Visual Studio Code, and CA Brightside.
  • Administrator
    Retrieve data for custom enterprise reports, such as Packages waiting approval or Packages recently deployed.
Element Actions
  • Automated Pipeline
    Fetch source elements from
    CA Endevor
    to distributed machines to perform static analysis on the source files (for example, CAST, SonarQube, CA Veracode).
  • Developer
    Fetch and upload individual source elements from
    CA Endevor
    in order to make source code changes in an editor of your choice through CA Brightside.
    Facilitate interaction with
    CA Endevor
    through IDE plugins such as Eclipse, CA Development Environment for z Systems, IBM Developer for z Systems, Eclipse Che, Visual Studio Code, and CA Brightside.
  • Administrator
    Retrieve data for custom enterprise reports, such as Elements changed per month.
Environment (Configuration) Actions
  • Developer Automated Workflow (Downstream Events)
    Automatically create a sandbox upon starting an Agile user story or defect.
Authentication
REST API communication is secured through the HTTP or HTTPS protocol. The REST API server authenticates using the Basic authentication type, and the mainframe username and password.
Action Request URIs
The RESTful model uses HTTP 1.1 and Uniform Resource Identifiers (URI). In the RESTful architectural style, data and functionality are considered resources, which are represented and accessed by URIs. These resources can be manipulated by a set of well-defined operations: Create, Read, Update, and Delete. To perform these operations on the resources, your client program uses the HTTP Request methods GET, PUT, POST, and DELETE. Which method is used depends on the action you want to perform.
The URI (Uniform Resource Identifier) for each request includes the URL (Uniform Resource Locator) to define the resource location. Some URIs also include the URN (Uniform Resource Name), depending on the action. Each URL includes the same base URL, the URL specific to an action, and may include action parameters. For more information about the action URLs and the action parameters for an action, see the descriptions for each action.
URL Structure
All RESTful actions have the same base URL, which is represented by the protocol, the host or server name, the port number, the EndevorService identifier, followed by the resource identifier (rest) for the RESTful Web Service root.
The URL addresses for the REST API operations have the following structure:
protocol
://
host
:
port
/EndevorService/rest/
targetConfiguration
where:
  • protocol
    Specifies whether http or https is enabled for your client program.
    Values:
    http, https
  • host
    Specifies the host or server name, or the domain name where the service is deployed and running.
  • port
    Specifies the port number that is defined on the web server.
  • targetConfiguration
    Specifies the target configuration name.
All URLs are case-sensitive.
Action Parameters
You can specify parameters on some of the action requests to influence action execution. For information about the parameters for an action, see the description for that action.
To use the parameters, follow these basic rules for URL query string building:
  • The query string is constructed as a series of parameter-value pairs that are located after the URI using the '?' character as a separator. ('?' is not part of the query string.)
  • Each parameter-value pair is separated by '=' sign.
  • Series of parameter-value pairs are separated by '&'
  • To use the special character in the URL, use the escape character ‘%’
  • For more information about query strings, see the w3c.org specifications for URL and URI.
Name Masking
You can use name masking to specify some variables in certain list actions. A name-masked value is not explicit, because it includes a full (*) or partial (for example, ENV*) wildcard, multiple placeholders (%), or both. When placeholders are used in a URI/URL, they must be “escaped” using the % character. For example, if used in a URI/URL they need to be: %25}
For wildcarding examples, see Inventory Actions for RESTful API.
Name masking is only supported on the variables shown in this table:
List action
Variable
List Packages
Package name
List System
Environment, Stage, System
List Subsystems
Environment, Stage, System, Subsystem
List Element
Environment, Stage, System, Subsystem, Type, Element
Multipart/Form-Data Type
The media-type multipart/form-data follows the rules of all multipart MIME data streams as outlined in RFC 1521. There are a series of fields to be supplied by the user who fills out the form. Each field has a name. Within a given form, the names are unique.
Multipart/form-data contains a series of parts. Each part is expected to contain a content-disposition header where the value is "form-data" and a name attribute specifies the field name within the form.
For example, 'content-disposition: form-data; name="xxxxx"', where xxxxx is the field name corresponding to that field. Field names, originally in non-ASCII character sets, may be encoded using the method that is outlined in RFC 1522.
As with all multipart MIME types, each part has an optional Content-Type which defaults to text/plain. If the contents of a file are returned via filling out a form, then the file input is identified as application/octet-stream or the appropriate media type, if known. Each part may be encoded and the "content-transfer-encoding" header is supplied if the value of that part does not conform to the default encoding.
File inputs may also identify the file name. The file name may be described using the 'filename' parameter of the "content-disposition" header. This is not required.
For more information about multipart type, see RFC 2388, section 7.
Example:
POST /EndevorService/rest/ENWSQA01/packages/PACKAGETST HTTP/1.1 Host: localhost:8080 Authorization: Basic VVNFUk0yOkhhbHV1eg== Content-Type: multipart/form-data;boundary=------FormBoundary157e7090204 Content-Length: 673 ------FormBoundary157e7090204 Content-Disposition: form-data; name="validateSCL" no ------FormBoundary157e7090204 Content-Disposition: form-data; name="description" Test package ------FormBoundary157e7090204 Content-Disposition: form-data; name="type" S ------FormBoundary157e7090204 Content-Disposition: form-data; name="sclfile"; filename="Package.SCL" Content-Type: text/plain ... contents of Package.SCL ... ------FormBoundary157e7090204--
Troubleshoot Errors
For errors that occur during request processing, the API returns an HTTP status code to the calling client. An error is indicated by a 4
nn
code or a 5
nn
code. Example:
Status: 400 Bad Request
In addition, some errors might include a JSON object/response that contains a message that describes the error. Use this information to diagnose the error or provide it to CA Support, if required.
OpenAPI Specification
This section contains documentation for the
CA Endevor
REST API that was generated from the OpenAPI Specification (formerly Swagger Specification).
none
{ "swagger":"2.0", "info":{ "description":"RESTful API to request information about available
CA Endevor
repositories, perform inventory, element, and package specific actions, and submit Software Control Language (SCL) files.", "version":"1.0.0", "title":"
CA Endevor
REST API" }, "basePath":"/EndevorService/rest", "tags":[ { "name":"Element" }, { "name":"List" }, { "name":"SubmitSCL" }, { "name":"Package" }, { "name":"Fingerprint" }, { "name":"Authentication" } ], "securityDefinitions": { "BasicAuth": { "type": "basic" }, "BearerAuth": { "type": "apiKey", "in": "header", "name": "Authorization" } }, "security": [ { "BasicAuth": [] }, { "BearerAuth": [] } ], "paths":{ "/":{ "get":{ "tags":[ "List" ], "summary":"List all datasources' configurations", "description":"Retrieve the configuration file content of all the datasources", "operationId":"getConfigurations", "produces":[ "application/json" ], "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "500":{ "description":"No predefined datasource" } } } }, "/{datasource}":{ "get":{ "tags":[ "List" ], "summary":"List a datasource's configuration", "description":"Retrieve the configuration file content of the datasource", "operationId":"getConfiguration", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Configuration supplied is not defined or is invalid" } } } }, "/{datasource}/auth":{ "get":{ "tags":[ "Authentication" ], "summary":"Get authentication token", "description":"Get authentication token or verify user/password.", "operationId":"getAuth", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation, token generated.", "schema":{ "$ref": "#/definitions/authResponse200" } }, "206":{ "description":"Successful operation, user verified, token not generated.", "schema":{ "$ref": "#/definitions/authResponse206" } }, "401":{ "description":"Not Authorized" }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/fingerprints":{ "put":{ "tags":[ "Fingerprint" ], "summary":"Validate Fingerprint", "description":"Validate Fingerprint", "operationId":"validateFingerprint", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"json request body", "required":true, "schema":{ "$ref": "#/definitions/validateFingerprint" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/validateFingerprintResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env":{ "get":{ "tags":[ "List" ], "summary":"List all environments", "description":"Extract Environment information from the Master Control Files that satisfies the criteria you specify", "operationId":"getEnvironments", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}":{ "get":{ "tags":[ "List" ], "summary":"List environment", "description":"Extract Environment information from the Master Control Files that satisfies the criteria you specify", "operationId":"getEnvironment", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum":{ "get":{ "tags":[ "List" ], "summary":"List all stages", "description":"Extract Stage Number information from the Master Control Files that satisfies the criteria you specify", "operationId":"getStages", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}":{ "get":{ "tags":[ "List" ], "summary":"List stage", "description":"Extract Stage Number information from the Master Control Files that satisfies the criteria you specify", "operationId":"getStage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys":{ "get":{ "tags":[ "List" ], "summary":"List all systems", "description":"Extract System information from the Master Control Files that satisfies the criteria you specify", "operationId":"getSystems", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}":{ "get":{ "tags":[ "List" ], "summary":"List system", "description":"Extract System information from the Master Control Files that satisfies the criteria you specify", "operationId":"getSystem", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys":{ "get":{ "tags":[ "List" ], "summary":"List all subsystems", "description":"Extract Subsystem information from the Master Control Files that satisfies the criteria you specify", "operationId":"getSubsystems", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}":{ "get":{ "tags":[ "List" ], "summary":"List subsystem", "description":"Extract Subsystem information from the Master Control Files that satisfies the criteria you specify", "operationId":"getSubsystem", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele":{ "get":{ "tags":[ "List", "Element" ], "summary":"List all elements", "description":"Extract Element information from the Master Control Files that satisfies the criteria you specify", "operationId":"getElements", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"data", "in":"query", "description":"the level of information returned. ALL-all information, BAS-basic summary, ELE-element summary, COMP-onent summary", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "BAS", "ELE", "COMP" ] }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] }, { "name":"whereCcidCurrent", "in":"query", "description":"accept values specified against the last action, generate, and last level CCIDs associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidGen", "in":"query", "description":"accept values specified against generate CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidLastAct", "in":"query", "description":"accept values specified against the last action CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidLastlvl", "in":"query", "description":"accept values specified against the last level CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidChange", "in":"query", "description":"filters the results of the list data summary function that is based on the specified ccids. DATA SUMMARY or DATA COMPONENT SUMMARY option needs to be specified. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidRetrieve", "in":"query", "description":"accept values specified against the last retrieve action CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereProcGroup", "in":"query", "description":"accept values specified against the Processor group associated with an Element. Accept up to 8 values separated by comma.", "required":false, "type":"string" }, { "name":"whereProcType", "in":"query", "description":"accept values specified against the Processor type associated with an Element. Accept up to 8 values separated by comma.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{printElement}":{ "get":{ "tags":[ "Element" ], "summary":"Print element", "description":"Prints selected information about Elements", "operationId":"printElement", "produces":[ "text/plain" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"printElement", "in":"path", "description":"element name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"toDDN", "in":"query", "description":"prints to external dataset", "required":false, "type":"string" }, { "name":"version", "in":"query", "description":"indicate the version number (1-99) of the element", "required":false, "type":"string" }, { "name":"level", "in":"query", "description":"indicate the level number (1-99) of the element", "required":false, "type":"string" }, { "name":"search", "in":"query", "description":"search through the map option. no-do not search, yes-search all the way up the map", "required":false, "type":"string", "default":"no", "enum":[ "yes", "no" ] }, { "name":"listString", "in":"query", "description":"specifies the 1-8 character text-string used to identify the listing data set to print", "required":false, "type":"string" }, { "name":"noHeadings", "in":"query", "description":"specifies if the default printing of a header on each page of output is suppressed or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"explode", "in":"query", "description":"specifies if the component info from ACMQ is printed or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"print", "in":"query", "description":"specifies the type of data to print out", "required":false, "type":"string", "enum":[ "browse/changes/history/summary/master/listing" ] }, { "name":"whereCcidCurrent", "in":"query", "description":"tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidAll", "in":"query", "description":"tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidRetrieve", "in":"query", "description":"tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field", "required":false, "type":"string" }, { "name":"whereProcGroup", "in":"query", "description":"select Elements according to a specified Processor group, wildcard supported", "required":false, "type":"string" } ], "responses":{ "200": { "description": "Text of print result", "schema": { "type": "string", "format": "base64" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{retrieveElement}":{ "get":{ "tags":[ "Element" ], "summary":"Retrieve element", "description":"Retrieves an existing element", "operationId":"retrieveElement", "produces":[ "application/octet-stream" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"retrieveElement", "in":"path", "description":"element name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"toDSN", "in":"query", "description":"destination data set name", "required":false, "type":"string" }, { "name":"toMember", "in":"query", "description":"destination member name inside the data set", "required":false, "type":"string" }, { "name":"toPath", "in":"query", "description":"destination USS path", "required":false, "type":"string" }, { "name":"toUSSFile", "in":"query", "description":"destination USS file", "required":false, "type":"string" }, { "name":"oveSign", "in":"query", "description":"specifies if you want to override the Signout of an element or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"noSignout", "in":"query", "description":"specifies if you want to perform the action with or without signing the element out", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"ccid", "in":"query", "description":"the CCID you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"comment", "in":"query", "description":"the comment you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"version", "in":"query", "description":"indicate the version number (1-99) of the element", "required":false, "type":"string" }, { "name":"level", "in":"query", "description":"indicate the level number (1-99) of the element", "required":false, "type":"string" }, { "name":"search", "in":"query", "description":"search through the map option. no-do not search, yes-search all the way up the map", "required":false, "type":"string", "default":"no", "enum":[ "yes", "no" ] }, { "name":"replaceMember", "in":"query", "description":"specifies if you want to replace the member currently in the library with the new element content or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"expandIncludes", "in":"query", "description":"specifies if the INCLUDE statements should be expanded in the course of the action or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"whereCcidCurrent", "in":"query", "description":"tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidAll", "in":"query", "description":"tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidRetrieve", "in":"query", "description":"tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field", "required":false, "type":"string" }, { "name":"whereProcGroup", "in":"query", "description":"select Elements according to a specified Processor group, wildcard supported", "required":false, "type":"string" } ], "responses":{ "200": { "description": "Content of the element", "schema": { "type": "string", "format": "binary" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{generateElement}":{ "put":{ "tags":[ "Element" ], "summary":"Generate Element", "description":"Generate an existing element", "operationId":"generateElement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"generateElement", "in":"path", "description":"element name, wildcard supported", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"json request body", "required":true, "schema":{ "$ref": "#/definitions/generateElement" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{moveElement}":{ "put":{ "tags":[ "Element" ], "summary":"Move Element", "description":"", "operationId":"moveElement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"moveElement", "in":"path", "description":"element name, wildcard supported", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"json request body", "required":true, "schema":{ "$ref": "#/definitions/moveElement" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{signinElement}":{ "put":{ "tags":[ "Element" ], "summary":"Signin Element", "description":"", "operationId":"signinElement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"signinElement", "in":"path", "description":"element name, wildcard supported", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"json request body", "required":true, "schema":{ "$ref": "#/definitions/signinElement" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{transferElement}":{ "put":{ "tags":[ "Element" ], "summary":"Transfer Element", "description":"", "operationId":"transferElement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"transferElement", "in":"path", "description":"element name, wildcard supported", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"json request body", "required":true, "schema":{ "$ref": "#/definitions/transferElement" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{element}":{ "get":{ "tags":[ "List", "Element" ], "summary":"List element", "description":"Extract Element information from the Master Control Files that satisfies the criteria you specify", "operationId":"getElement", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"element", "in":"path", "description":"element name, wildcard supported", "required":true, "type":"string" }, { "name":"data", "in":"query", "description":"the level of information returned. ALL-all information, BAS-basic summary, ELE-element summary, COMP-onent summary", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "BAS", "ELE", "COMP" ] }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] }, { "name":"whereCcidCurrent", "in":"query", "description":"accept values specified against the last action, generate, and last level CCIDs associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidGen", "in":"query", "description":"accept values specified against generate CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidLastAct", "in":"query", "description":"accept values specified against the last action CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidLastlvl", "in":"query", "description":"accept values specified against the last level CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidChange", "in":"query", "description":"filters the results of the list data summary function that is based on the specified ccids. DATA SUMMARY or DATA COMPONENT SUMMARY option needs to be specified. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereCcidRetrieve", "in":"query", "description":"accept values specified against the last retrieve action CCID associated with an Element. Accept up to 8 values separated by comma. Only 1 ccid query is accepted per request.", "required":false, "type":"string" }, { "name":"whereProcGroup", "in":"query", "description":"accept values specified against the Processor group associated with an Element. Accept up to 8 values separated by comma.", "required":false, "type":"string" }, { "name":"whereProcType", "in":"query", "description":"accept values specified against the Processor type associated with an Element. Accept up to 8 values separated by comma.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } }, "post":{ "tags":[ "Element" ], "summary":"Add element", "description":"Creates an element", "operationId":"addElement", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"element", "in":"path", "description":"element name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"fromDSN", "in":"formData", "description":"use this input to provide source data set name", "required":false, "type":"string" }, { "name":"fromMember", "in":"formData", "description":"use this input to provide source member name in the data set", "required":false, "type":"string" }, { "name":"fromPath", "in":"formData", "description":"use this input to provide the path of source USS file", "required":false, "type":"string" }, { "name":"fromUSSFile", "in":"formData", "description":"use this input to provide source USS file", "required":false, "type":"string" }, { "name":"fromFile", "in":"formData", "description":"use this input to provide source file", "required":false, "type":"file" }, { "name":"newVersion", "in":"formData", "description":"assign a different version number to the Element", "required":false, "type":"string" }, { "name":"oveSign", "in":"formData", "description":"specifies if you want to override the Signout of an element or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"ccid", "in":"formData", "description":"the CCID you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"comment", "in":"formData", "description":"the comment you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"generate", "in":"formData", "description":"specifies if you want to Generate Element after Add action (default is no)", "required":false, "type":"string", "enum":[ "yes", "no" ] }, { "name":"procGroup", "in":"formData", "description":"specifies which Processor Group will be used for the Add action (default is the default processor group for this type)", "required":false, "type":"string" }, { "name":"fingerprint", "in":"formData", "description":"the 16-digit hex fingerprint used to check if the Element is up-to-date", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } }, "put":{ "tags":[ "Element" ], "summary":"Update element", "description":"updates an existing element", "operationId":"updateElement", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"element", "in":"path", "description":"element name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"fromDSN", "in":"formData", "description":"use this input to provide source data set name", "required":false, "type":"string" }, { "name":"fromMember", "in":"formData", "description":"use this input to provide source member name in the data set", "required":false, "type":"string" }, { "name":"fromPath", "in":"formData", "description":"use this input to provide the path of source USS file", "required":false, "type":"string" }, { "name":"fromUSSFile", "in":"formData", "description":"use this input to provide source USS file", "required":false, "type":"string" }, { "name":"fromFile", "in":"formData", "description":"use this input to provide source file", "required":false, "type":"file" }, { "name":"oveSign", "in":"formData", "description":"specifies if you want to override the Signout of an element or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"ccid", "in":"formData", "description":"the CCID you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"comment", "in":"formData", "description":"the comment you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"generate", "in":"formData", "description":"specifies if you want to Generate Element after Update action (default is no)", "required":false, "type":"string", "enum":[ "yes", "no" ] }, { "name":"procGroup", "in":"formData", "description":"specifies which Processor Group will be used for the Update action (default is the current group)", "required":false, "type":"string" }, { "name":"fingerprint", "in":"formData", "description":"the 16-digit hex fingerprint used to check if the Element is up-to-date", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } }, "delete":{ "tags":[ "Element" ], "summary":"Delete element", "description":"deletes an existing element", "operationId":"deleteElement", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"element", "in":"path", "description":"element name, wildcard supported", "required":true, "type":"string" }, { "name":"oveSign", "in":"query", "description":"specifies if you want to override the Signout of an element or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"ccid", "in":"query", "description":"the CCID you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"comment", "in":"query", "description":"the comment you want to use when performing an Element action", "required":false, "type":"string" }, { "name":"onlyComponents", "in":"query", "description":"specifies if both the Element component list and the Element are deleted, or the Element component list only", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"whereCcidCurrent", "in":"query", "description":"tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidAll", "in":"query", "description":"tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidRetrieve", "in":"query", "description":"tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field", "required":false, "type":"string" }, { "name":"whereProcGroup", "in":"query", "description":"select Elements according to a specified Processor group, wildcard supported", "required":false, "type":"string" }, { "name":"fingerprint", "in":"query", "description":"the 16-digit hex fingerprint used to check if the Element is up-to-date", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{element}/components":{ "get":{ "tags":[ "Element" ], "summary":"Print element components", "description":"Prints selected component information about Elements", "operationId":"printComponents", "produces":[ "text/plain" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"element", "in":"path", "description":"element name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"toDDN", "in":"query", "description":"prints to external dataset", "required":false, "type":"string" }, { "name":"version", "in":"query", "description":"indicate the version number (1-99) of the element", "required":false, "type":"string" }, { "name":"level", "in":"query", "description":"indicate the level number (1-99) of the element", "required":false, "type":"string" }, { "name":"search", "in":"query", "description":"search through the map option. no-do not search, yes-search all the way up the map", "required":false, "type":"string", "default":"no", "enum":[ "yes", "no" ] }, { "name":"noHeadings", "in":"query", "description":"specifies if the default printing of a header on each page of output is suppressed or not", "required":false, "type":"string", "enum":[ "yes", "no" ] }, { "name":"explode", "in":"query", "description":"specifies if the component info from ACMQ is printed or not", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"print", "in":"query", "description":"specifies the type of data to print out", "required":false, "type":"string", "enum":[ "browse/changes/history/summary" ] }, { "name":"whereCcidCurrent", "in":"query", "description":"tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidAll", "in":"query", "description":"tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID", "required":false, "type":"string" }, { "name":"whereCcidRetrieve", "in":"query", "description":"tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field", "required":false, "type":"string" }, { "name":"whereProcGroup", "in":"query", "description":"select Elements according to a specified Processor group, wildcard supported", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/subsys/{subsystem}/type/{type}/ele/{element}/acm":{ "get":{ "tags":[ "Element", "List" ], "summary":"List components used by element", "description":"List of components used by the given element", "operationId":"inputComponents", "produces":[ "text/plain" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"subsystem", "in":"path", "description":"subsystem name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"element", "in":"path", "description":"element name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"excCirculars", "in":"query", "description":"Filters the ACM data to exclude components that have a circular relationship to the object of your search", "required":false, "type":"string", "default":"no", "enum":[ "yes", "no" ] }, { "name":"excIndirect", "in":"query", "description":"Filters the ACM data to exclude indirectly related components", "required":false, "type":"string", "default":"no", "enum":[ "yes", "no" ] }, { "name":"excRelated", "in":"query", "description":"Filters the ACM data to exclude related components", "required":false, "type":"string", "default":"no", "enum":[ "yes", "no" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/type":{ "get":{ "tags":[ "List" ], "summary":"List all types", "description":"Extract Type information from the Master Control Files that satisfies the criteria you specify", "operationId":"getTypes", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/type/{type}":{ "get":{ "tags":[ "List" ], "summary":"List type", "description":"Extract Type information from the Master Control Files that satisfies the criteria you specify", "operationId":"getType", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/type/{type}/pgroup":{ "get":{ "tags":[ "List" ], "summary":"List all processor groups", "description":"Extract Processor Groups information from the Master Control Files that satisfies the criteria you specify", "operationId":"getProcessorGroups", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/env/{environment}/stgnum/{stage}/sys/{system}/type/{type}/pgroup/{pgroup}":{ "get":{ "tags":[ "List" ], "summary":"List Processor Group", "description":"Extract Processor Group information from the Master Control Files that satisfies the criteria you specify", "operationId":"getProcessorGroup", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"environment", "in":"path", "description":"environment name, wildcard supported", "required":true, "type":"string" }, { "name":"stage", "in":"path", "description":"stage number, wildcard supported", "required":true, "type":"string" }, { "name":"system", "in":"path", "description":"system name, wildcard supported", "required":true, "type":"string" }, { "name":"type", "in":"path", "description":"type name, wildcard supported", "required":true, "type":"string" }, { "name":"pgroup", "in":"path", "description":"processor group name, wildcard supported", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"mapping path option. LOG-logical, PHY-Physical", "required":false, "type":"string", "enum":[ "LOG/PHY" ] }, { "name":"search", "in":"query", "description":"search through the map option. NOS-do not search, SEA-search all the way up the map", "required":false, "type":"string", "enum":[ "NOS/SEA" ] }, { "name":"return", "in":"query", "description":"return option. FIR-return first found, ALL-return all", "required":false, "type":"string", "enum":[ "FIR/ALL" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages":{ "get":{ "tags":[ "List", "Package" ], "summary":"List all packages", "description":"Extract Package information that satisfies the criteria you specify", "operationId":"getPackages", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"status", "in":"query", "description":"package status", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "INEDIT", "INAPPROVAL", "APPROVED", "INEXECUTION", "EXECUTED", "COMMITTED", "DENIED", "EXECFAILED" ] }, "collectionFormat":"multi" }, { "name":"type", "in":"query", "description":"package type. S-standard, E-emergency", "required":false, "type":"string", "enum":[ "S/E" ] }, { "name":"enterprise", "in":"query", "description":"enterprise Package parameter. A-all, E-enterprise, X-exclude", "required":false, "type":"string", "enum":[ "A/E/X" ] }, { "name":"promotion", "in":"query", "description":"promotion Package parameter. A-all, P-promotion, X-exclude", "required":false, "type":"string", "enum":[ "A/P/X" ] }, { "name":"targetenv", "in":"query", "description":"promotion Package target environment. A-all, P-promotion", "required":false, "type":"string", "enum":[ "A/P" ] }, { "name":"targetstg", "in":"query", "description":"promotion Package target stage ID. A-all, P-promotion", "required":false, "type":"string", "enum":[ "A/P" ] }, { "name":"approver", "in":"query", "description":"package approver ID, wildcard NOT supported", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}":{ "get":{ "tags":[ "List", "Package" ], "summary":"List package", "description":"Extract Package information that satisfies the criteria you specify", "operationId":"getPackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard supported", "required":true, "type":"string" }, { "name":"status", "in":"query", "description":"package status", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "INEDIT", "INAPPROVAL", "APPROVED", "INEXECUTION", "EXECUTED", "COMMITTED", "DENIED", "EXECFAILED" ] }, "collectionFormat":"multi" }, { "name":"type", "in":"query", "description":"package type. S-standard, E-emergency", "required":false, "type":"string", "enum":[ "S/E" ] }, { "name":"enterprise", "in":"query", "description":"enterprise Package parameter. A-all, E-enterprise, X-exclude", "required":false, "type":"string", "enum":[ "A/E/X" ] }, { "name":"promotion", "in":"query", "description":"promotion Package parameter. A-all, P-promotion, X-exclude", "required":false, "type":"string", "enum":[ "A/P/X" ] }, { "name":"targetenv", "in":"query", "description":"promotion Package target environment. A-all, P-promotion", "required":false, "type":"string", "enum":[ "A/P" ] }, { "name":"targetstg", "in":"query", "description":"promotion Package target stage ID. A-all, P-promotion", "required":false, "type":"string", "enum":[ "A/P" ] }, { "name":"approver", "in":"query", "description":"package approver ID, wildcard NOT supported", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } }, "post":{ "tags":[ "Package" ], "summary":"Create package", "description":"Creates a Package", "operationId":"createPackage", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"description", "in":"formData", "description":"allows you to associate a 50-character description with the Package", "required":false, "type":"file" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"type", "in":"formData", "description":"package type. S-standard, E-emergency", "required":false, "type":"string", "enum":[ "S/E" ] }, { "name":"sharable", "in":"formData", "description":"specifies whether this Package can be edited by more than one person when in In-edit status", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"backout", "in":"formData", "description":"specifies whether you want to have the backout facility available for this Package", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"append", "in":"formData", "description":"specifies whether to append the SCL you are adding to the existing Package SCL or to replace it", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"fromPackage", "in":"formData", "description":"copy the SCL from the Package you specify", "required":false, "type":"string" }, { "name":"fromDSN", "in":"formData", "description":"copy the SCL from the data set you specify", "required":false, "type":"string" }, { "name":"fromMember", "in":"formData", "description":"copy the SCL from the member you specify", "required":false, "type":"string" }, { "name":"validateSCL", "in":"formData", "description":"specifies if you want to validate the Package components while updating a Package", "required":false, "type":"string", "default":"yes", "enum":[ "yes", "no" ] }, { "name":"promotion", "in":"formData", "description":"specifies whether this Package is promotion Package", "required":false, "type":"string", "enum":[ "yes", "no" ] }, { "name":"ewfromdate", "in":"formData", "description":"specifies the beginning of date within which the package can be executed", "required":false, "type":"string" }, { "name":"ewfromtime", "in":"formData", "description":"specifies the beginning of time within which the package can be executed", "required":false, "type":"string" }, { "name":"ewtodate", "in":"formData", "description":"specifies the end of date within which the package can be executed", "required":false, "type":"string" }, { "name":"ewtotime", "in":"formData", "description":"specifies the end of time within which the package can be executed", "required":false, "type":"string" }, { "name":"sclfile", "in":"formData", "description":"use this input to provide the SCL into the Package", "required":false, "type":"file" }, { "name":"notesfile", "in":"formData", "description":"use this input to add remarks to the Package definition", "required":false, "type":"file" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } }, "put":{ "tags":[ "Package" ], "summary":"Update package", "description":"Updates an existing Package or create a new one if it does not exists", "operationId":"updatePackage", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"description", "in":"formData", "description":"allows you to associate a 50-character description with the Package", "required":false, "type":"file" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"type", "in":"formData", "description":"package type. S-standard, E-emergency", "required":false, "type":"string", "enum":[ "S/E" ] }, { "name":"sharable", "in":"formData", "description":"specifies whether this Package can be edited by more than one person when in In-edit status", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"backout", "in":"formData", "description":"specifies whether you want to have the backout facility available for this Package", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"append", "in":"formData", "description":"specifies whether to append the SCL you are adding to the existing Package SCL or to replace it", "required":false, "type":"string", "enum":[ "yes/no" ] }, { "name":"fromPackage", "in":"formData", "description":"copy the SCL from the Package you specify", "required":false, "type":"string" }, { "name":"fromDSN", "in":"formData", "description":"copy the SCL from the data set you specify", "required":false, "type":"string" }, { "name":"fromMember", "in":"formData", "description":"copy the SCL from the member you specify", "required":false, "type":"string" }, { "name":"validateSCL", "in":"formData", "description":"specifies if you want to validate the Package components while updating a Package", "required":false, "type":"string", "default":"yes", "enum":[ "yes", "no" ] }, { "name":"promotion", "in":"formData", "description":"specifies whether this Package is promotion Package", "required":false, "type":"string", "enum":[ "yes", "no" ] }, { "name":"ewfromdate", "in":"formData", "description":"specifies the beginning of date within which the package can be executed", "required":false, "type":"string" }, { "name":"ewfromtime", "in":"formData", "description":"specifies the beginning of time within which the package can be executed", "required":false, "type":"string" }, { "name":"ewtodate", "in":"formData", "description":"specifies the end of date within which the package can be executed", "required":false, "type":"string" }, { "name":"ewtotime", "in":"formData", "description":"specifies the end of time within which the package can be executed", "required":false, "type":"string" }, { "name":"sclfile", "in":"formData", "description":"use this input to provide the SCL into the Package you are updating", "required":false, "type":"file" }, { "name":"notesfile", "in":"formData", "description":"use this input to add remarks to the Package definition", "required":false, "type":"file" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } }, "delete":{ "tags":[ "Package" ], "summary":"Delete package", "description":"delete packages", "operationId":"deletePackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard supported", "required":true, "type":"string" }, { "name":"status", "in":"query", "description":"package status", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "ALLSTATE", "INEDIT", "INAPPROVAL", "APPROVED", "INEXECUTION", "EXECUTED", "EXECFAILED", "COMMITTED", "DENIED" ] }, "collectionFormat":"multi" }, { "name":"olderthan", "in":"query", "description":"allows you to specify the minimum age of the Package", "required":false, "type":"integer", "default":0, "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/directory":{ "get":{ "tags":[ "List" ], "summary":"List Directories", "description":"The List Directory request allows you to build a directory list of members in a dataset, a list of CSECT for one or more members of a load library and a list of files and folders in an USS directory.", "operationId":"getDirectories", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"ddname", "in":"query", "description":"File or DD name where member(s) reside. You must specify ddname, dsname or path query.", "required":true, "type":"string" }, { "name":"dsname", "in":"query", "description":"Data set name where member(s) reside. You must specify either ddname, dsname or path query.", "required":true, "type":"string" }, { "name":"path", "in":"query", "description":"USS path that wants to be listed. You must specify either ddname, dsname or path query.", "required":true, "type":"string" }, { "name":"memName", "in":"query", "description":"Member name. Wildcarding is permitted. Only permitted with the ddname and dsname queries.", "required":false, "type":"string" }, { "name":"thruMem", "in":"query", "description":"Through member name. Wildcarding is permitted. Only permitted when memName is defined and with the ddname and dsname queries", "required":false, "type":"string" }, { "name":"csect", "in":"query", "description":"Request CSECT flag. Only permitted with the ddname and dsname queries", "required":false, "type":"string", "default":"NO", "enum":[ "YES", "NO" ] }, { "name":"file", "in":"query", "description":"File name. Wildcarding is permitted. Only permitted with the path query.", "required":false, "type":"string" }, { "name":"thruFile", "in":"query", "description":"Through file name. Wildcarding is permitted. Only permitted when file is defined and with the path query.", "required":false, "type":"string" }, { "name":"subdirectories", "in":"query", "description":"Request subdirectories flag. Only permitted with the path query.", "required":false, "type":"string", "default":"NO", "enum":[ "YES", "NO" ] } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/listResponse200" } }, "400":{ "description":"Configuration supplied is not defined or is invalid" }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Approve":{ "put":{ "tags":[ "Package" ], "summary":"Approve package", "description":"approve a package", "operationId":"approvePackage", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "required":true, "type":"string" }, { "name": "body", "in": "body", "description": "provides JSON with note1/note2/note3/../note8 parameters specifying lines in notes", "required": false, "schema":{ "$ref": "#/definitions/notesPackageJson" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Backin":{ "put":{ "tags":[ "Package" ], "summary":"Backin package", "description":"backin a package", "operationId":"backinPackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"statement", "in":"query", "description":"specifies the SCL statement number for the Element action", "required":false, "type":"integer", "format":"int32" }, { "name":"element", "in":"query", "description":"specifies the element name for the Element action", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Backout":{ "put":{ "tags":[ "Package" ], "summary":"Backout package", "description":"backout a package after it has been executed", "operationId":"backoutPackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"statement", "in":"query", "description":"specifies the SCL statement number for the Element action", "required":false, "type":"integer", "format":"int32" }, { "name":"element", "in":"query", "description":"specifies the element name for the Element action", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Cast":{ "put":{ "tags":[ "Package" ], "summary":"Cast package", "description":"prepares the Package for review and subsequent execution", "operationId":"castPackage", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name": "body", "in": "body", "description": "provides JSON request body with parameters", "required": false, "schema":{ "$ref": "#/definitions/castPackage" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Commit":{ "put":{ "tags":[ "Package" ], "summary":"Commit package", "description":"removes all backout/backin data while retaining Package event information", "operationId":"commitPackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"olderthan", "in":"query", "description":"allows you to specify the minimum age of the Package", "required":false, "type":"integer", "default":0, "format":"int32" }, { "name":"delete-promotion-history", "in":"query", "description":"specifies if you want to delete all the promotion history associated with previous versions of the Package", "required":false, "type":"boolean", "default":false } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Deny":{ "put":{ "tags":[ "Package" ], "summary":"Deny package", "description":"deny a package", "operationId":"denyPackage", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "required":true, "type":"string" }, { "name": "body", "in": "body", "description": "provides JSON with note1/note2/note3/../note8 parameters specifying lines in notes", "required": false, "schema":{ "$ref": "#/definitions/notesPackageJson" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Execute":{ "put":{ "tags":[ "Package" ], "summary":"Execute package", "description":"executes a package", "operationId":"executePackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard supported", "required":true, "type":"string" }, { "name":"status", "in":"query", "description":"package status", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "APPROVED", "EXECFAILED" ] }, "collectionFormat":"multi" }, { "name":"ewfromdate", "in":"query", "description":"specifies the beginning of date within which the package can be executed", "required":false, "type":"string" }, { "name":"ewfromtime", "in":"query", "description":"specifies the beginning of time within which the package can be executed", "required":false, "type":"string" }, { "name":"ewtodate", "in":"query", "description":"specifies the end of date within which the package can be executed", "required":false, "type":"string" }, { "name":"ewtotime", "in":"query", "description":"specifies the end of time within which the package can be executed", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Reset":{ "put":{ "tags":[ "Package" ], "summary":"Reset package", "description":"set the status of a Package back to In-edit", "operationId":"resetPackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"retain", "in":"query", "description":"retain promotion history", "required":false, "type":"boolean", "default":false } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Ship":{ "put":{ "tags":[ "Package" ], "summary":"Ship package", "description":"ship a Package to a remote site", "operationId":"shipPackage", "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"destination", "in":"query", "description":"name of the remote site", "required":false, "type":"string" }, { "name":"option", "in":"query", "description":"specifies whether you want to ship output members, or backout members", "required":false, "type":"string", "enum":[ "OUTPUT/BACKOUT" ] }, { "name":"prefix", "in":"query", "description":"specifies the data set name prefix to be used in the XCOM or CONNECT:DIRECT transmission methods", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/packages/{packagename}/Submit":{ "put":{ "tags":[ "Package" ], "summary":"Submit package", "description":"submits a package", "operationId":"submitPackage", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"packagename", "in":"path", "description":"package name, wildcard NOT supported", "required":true, "type":"string" }, { "name":"sclfile", "in":"formData", "description":"use this input to provide the SCL into the Package", "required":false, "type":"file" }, { "name":"fromDSN", "in":"formData", "description":"copy the SCL from the data set you specify", "required":false, "type":"string" }, { "name":"fromMember", "in":"formData", "description":"copy the SCL from the member you specify", "required":false, "type":"string" }, { "name":"toCA7", "in":"formData", "description":"submit package to CA7", "required":false, "type":"string" }, { "name":"toDDName", "in":"formData", "description":"submit package according to a DDName specified in the starter task", "required":false, "type":"string" }, { "name":"status", "in":"formData", "description":"package status", "required":false, "type":"string", "enum":[ "APPROVED", "EXECFAILED" ] }, { "name":"multStreams", "in":"formData", "description":"specifes if you want to submit a separate, unique job for each package or not", "required":false, "type":"string" }, { "name":"incrJobName", "in":"formData", "description":"specifies if you want to increases the last character in the jobcard you provide or not", "required":false, "type":"string" }, { "name":"jclProc", "in":"formData", "description":"the name of the JCL procedure that you want to invoke", "required":false, "type":"string" }, { "name":"CA7depJob", "in":"formData", "description":"Specifies a single predecessor job which must complete while demanded job is waiting in the CA7 scheduler", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } }, "/{datasource}/scl":{ "post":{ "tags":[ "SubmitSCL" ], "summary":"Submit SCL", "description":"Submits a SCL file to be executed", "operationId":"scl", "consumes":[ "multipart/form-data" ], "parameters":[ { "name":"datasource", "in":"path", "description":"datasource name", "required":true, "type":"string" }, { "name":"sclString", "in":"formData", "description":"the SCL string to be submitted", "required":false, "type":"string" }, { "name":"submitType", "in":"formData", "description":"the category of
CA Endevor
SCL", "required":false, "type":"string", "enum":[ "list", "element", "package", "admin", "ship", "addUpdRtv" ] }, { "name":"fromLocalFile", "in":"formData", "description":"use this input to provide source file required by SCL", "required":false, "type":"file" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref": "#/definitions/response200" } }, "400":{ "description":"Bad request. Please refer to the returned messages", "schema":{ "$ref": "#/definitions/response400" } }, "500":{ "description":"Internal Server error" } } } } }, "definitions": { "castPackage": { "type": "object", "properties": { "backout": { "type": "string", "description": "Specifies whether the backout facility is available for this Package.", "default":"yes", "enum":[ "yes", "no" ] }, "validate-components": { "type": "string", "description": "Specifies whether component validation is to be performed.", "enum":[ "yes/no/warn" ] }, "ewfromdate": { "type": "string", "description": "Specifies the beginning of time within which the package can be executed." }, "ewfromtime": { "type": "string", "description": "Specifies the beginning of time within which the package can be executed." }, "ewtodate": { "type": "string", "description": "Specifies the end of date within which the package can be executed." }, "ewtotime": { "type": "string", "description": "Specifies the end of time within which the package can be executed." }, "notes1": { "type": "string", "description": "Specifies 1st note." }, "notes2": { "type": "string", "description": "Specifies 2nd note." }, "notes3": { "type": "string", "description": "Specifies 3rd note." }, "notes4": { "type": "string", "description": "Specifies 4th note." }, "notes5": { "type": "string", "description": "Specifies 5th note." }, "notes6": { "type": "string", "description": "Specifies 6th note." }, "notes7": { "type": "string", "description": "Specifies 7th note." }, "notes8": { "type": "string", "description": "Specifies 8th note." } } }, "notesPackageJson": { "type": "object", "properties": { "notes1": { "type": "string", "description": "Specifies 1st note." }, "notes2": { "type": "string", "description": "Specifies 2nd note." }, "notes3": { "type": "string", "description": "Specifies 3rd note." }, "notes4": { "type": "string", "description": "Specifies 4th note." }, "notes5": { "type": "string", "description": "Specifies 5th note." }, "notes6": { "type": "string", "description": "Specifies 6th note." }, "notes7": { "type": "string", "description": "Specifies 7th note." }, "notes8": { "type": "string", "description": "Specifies 8th note." } } }, "generateElement": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Use \"generate\" for generate element action", "example": "generate" }, "ccid": { "type": "string", "description": "The CCID you want to use when performing an Element action." }, "comment": { "type": "string", "description": "The comment you want to use when performing an Element action" }, "search": { "type": "string", "description": "Search through the map option", "enum":[ "yes/no" ] }, "oveSign": { "type": "string", "description": "Specifies if you want to override the Signout of an element or not", "enum":[ "yes/no" ] }, "copyBack": { "type": "string", "description": "Specifies if you want to copy the current level of the Element back to the FROM Stage", "enum":[ "yes/no" ] }, "noSource": { "type": "string", "description": "Specifies if you want to have source-less Element", "enum":[ "yes/no" ] }, "procGroup": { "type": "string", "description": "The processor group you would like to use" }, "whereProcGroup": { "type": "string", "description": "Select Elements according to a specified Processor group, wildcard supported" }, "whereCcidCurrent": { "type": "string", "description": "Tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID" }, "whereCcidAll": { "type": "string", "description": "Tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID" }, "whereCcidRetrieve": { "type": "string", "description": "Tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field" } } }, "moveElement": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Use \"move\" for move element action", "example": "move" }, "ccid": { "type": "string", "description": "The CCID you want to use when performing an Element action." }, "comment": { "type": "string", "description": "The comment you want to use when performing an Element action" }, "sync": { "type": "string", "description": "Specifies if you want to synchronize source and current level of the Elements", "enum":[ "yes/no" ] }, "withHistory": { "type": "string", "description": "Specifies if you want to preserve the change history of the Elements", "enum":[ "yes/no" ] }, "bypassElementDelete": { "type": "string", "description": "Specifies if you want to retain the Elements in the source Stage after successfully completing this action", "enum":[ "yes/no" ] }, "retainSignOut": { "type": "string", "description": "Specifies if you want to retain the source location signouts for all Elements at the target location", "enum":[ "yes/no" ] }, "signOutTo": { "type": "string", "description": "Specifies if you want to sign all Elements out to the specified user ID at the target Stage" }, "jump": { "type": "string", "description": "Specifies if you want to move Elements across Environments", "enum":[ "yes/no" ] }, "whereProcGroup": { "type": "string", "description": "Select Elements according to a specified Processor group, wildcard supported" }, "whereCcidCurrent": { "type": "string", "description": "Tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID" }, "whereCcidAll": { "type": "string", "description": "Tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID" }, "whereCcidRetrieve": { "type": "string", "description": "Tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field" } } }, "signinElement": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Use \"signin\" for signin element action", "example": "signin" }, "ccid": { "type": "string", "description": "The CCID you want to use when performing an Element action." }, "comment": { "type": "string", "description": "The comment you want to use when performing an Element action" }, "search": { "type": "string", "description": "Search through the map option", "enum":[ "yes/no" ] }, "oveSign": { "type": "string", "description": "Specifies if you want to override the Signout of an element or not", "enum":[ "yes/no" ] }, "signOutTo": { "type": "string", "description": "Specifies if you want to sign all Elements out to the specified user ID at the target Stage" }, "whereProcGroup": { "type": "string", "description": "Select Elements according to a specified Processor group, wildcard supported" }, "whereCcidCurrent": { "type": "string", "description": "Tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID" }, "whereCcidAll": { "type": "string", "description": "Tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID" }, "whereCcidRetrieve": { "type": "string", "description": "Tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field" } } }, "transferElement": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Use \"transfer\" for transfer element action", "example": "transfer" }, "ccid": { "type": "string", "description": "The CCID you want to use when performing an Element action." }, "comment": { "type": "string", "description": "The comment you want to use when performing an Element action" }, "toEnvironment": { "type": "string", "description": "Target environment name" }, "toStageNum": { "type": "string", "description": "Target stage number" }, "toSystem": { "type": "string", "description": "Target system name" }, "toSubsystem": { "type": "string", "description": "Target subsystem name" }, "toType": { "type": "string", "description": "Target type name" }, "toElement": { "type": "string", "description": "Target element name" }, "version": { "type": "string", "description": "Indicate the version number (1-99) of the element" }, "level": { "type": "string", "description": "Indicate the level number (1-99) of the element" }, "newVersion": { "type": "string", "description": "Assign a different version number to the Element" }, "sync": { "type": "string", "description": "Specifies if you want to synchronize source and current level of the Elements", "enum":[ "yes/no" ] }, "withHistory": { "type": "string", "description": "Specifies if you want to preserve the change history of the Elements", "enum":[ "yes/no" ] }, "procGroup": { "type": "string", "description": "The processor group you would like to use" }, "ignoreGenerateFailed": { "type": "string", "description": "Process the request regardless of whether the FAILED flag is set for the element", "enum":[ "yes/no" ] }, "bypassElementDelete": { "type": "string", "description": "Specifies if you want to retain the Elements in the source Stage after successfully completing this action", "enum":[ "yes/no" ] }, "bypassDeleteProc": { "type": "string", "description": "Specifies to bypasses the execution of the delete processor", "enum":[ "yes/no" ] }, "bypassGenerateProc": { "type": "string", "description": "Specifies to bypasses the execution of the generate or move processor", "enum":[ "yes/no" ] }, "retainSignOut": { "type": "string", "description": "Specifies if you want to retain the source location signouts for all Elements at the target location", "enum":[ "yes/no" ] }, "signOutTo": { "type": "string", "description": "Specifies if you want to sign all Elements out to the specified user ID at the target Stage" }, "jump": { "type": "string", "description": "Specifies if you want to move Elements across Environments", "enum":[ "yes/no" ] }, "whereProcGroup": { "type": "string", "description": "Select Elements according to a specified Processor group, wildcard supported" }, "whereCcidCurrent": { "type": "string", "description": "Tells Endevor to look through the CCID fields in the Master Control File to find a specified CCID" }, "whereCcidAll": { "type": "string", "description": "Tells Endevor to look through the CCID fields in both the Master Control File and the SOURCE DELTA levels to find a specified CCID" }, "whereCcidRetrieve": { "type": "string", "description": "Tells Endevor to use the CCID in the Master Control File RETRIEVE CCID field" } } }, "validateFingerprint": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Use \"validate\" for validate fingerprint action", "example": "validate" }, "fingerprints": { "type": "array", "items": { "type": "object", "properties": { "elmName": { "description":"element real name", "type":"string" }, "envName": { "description":"environment name", "type":"string" }, "stgNum": { "description":"stage number", "type":"string" }, "sysName": { "description":"system name", "type":"string" }, "sbsName": { "description":"subsystem name", "type":"string" }, "typeName": { "description":"type name", "type":"string" }, "fingerprint": { "description":"the 16-digit hex fingerprint used to check if the Element is up-to-date", "type":"string" } } } } } }, "authResponse200": { "type": "object", "properties": { "returnCode": { "type": "string", "example": "0000" }, "reasonCode": { "type": "string", "example": "0000" }, "token": { "type": "string", "example": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NDc1NTYyOTAsInVzZXJuYW1lIjoidXNlciIsInBhc3N0aWNrZXQiOiJwYXNzIiwiZXhwIjoxNTQ3NTU2ODkwfQ.BR3jJt-NaYCT3LAEVP5eEMohqgDP1EvMWgv1QDAFaYQ" }, "tokenCreatedOn": { "type": "string", "example": "2019/01/15 13:44:50" }, "tokenValidFor": { "type": "string", "example": "10" }, "messages": { "type": "string" } } }, "authResponse206": { "type": "object", "properties": { "returnCode": { "type": "string", "example": "0008" }, "reasonCode": { "type": "string", "example": "0025" }, "token": { "type": "null" }, "tokenCreatedOn": { "type": "null" }, "tokenValidFor": { "type": "null" }, "messages": { "type": "string", "example": "Token not generated. Passticket Service is not set." } } }, "validateFingerprintResponse200": { "type": "object", "properties": { "returnCode": { "type": "string", "example": "0000" }, "reasonCode": { "type": "string", "example": "0000" }, "reports": { "type": "object", "properties": { "APIMSGS": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-APIMSGS" }, "C1MSGS1": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-C1MSGS1" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "changed": { "type": "array", "items": { "type": "object", "properties": { "elmName": { "description":"element real name", "type":"string" }, "fullElmName": { "description": "long element real name", "type": "string" }, "envName": { "description":"environment name", "type":"string" }, "stgNum": { "description":"stage number", "type":"string" }, "sysName": { "description":"system name", "type":"string" }, "sbsName": { "description":"subsystem name", "type":"string" }, "typeName": { "description":"type name", "type":"string" }, "fingerprint": { "description":"the 16-digit hex fingerprint used to check if the Element is up-to-date", "type":"string" } } } }, "notfound": { "type": "array", "items": { "type": "object", "properties": { "elmName": { "description":"element real name", "type":"string" }, "fullElmName": { "description": "long element real name", "type": "string" }, "envName": { "description":"environment name", "type":"string" }, "stgNum": { "description":"stage number", "type":"string" }, "sysName": { "description":"system name", "type":"string" }, "sbsName": { "description":"subsystem name", "type":"string" }, "typeName": { "description":"type name", "type":"string" }, "fingerprint": { "description":"the 16-digit hex fingerprint used to check if the Element is up-to-date", "type":"string" } } } } } } }, "messages": { "type": "string" } } }, "listResponse200": { "type": "object", "properties": { "returnCode": { "type": "string", "example": "0000" }, "reasonCode": { "type": "string", "example": "0000" }, "reports": { "type": "object", "properties": { "APIMSGS": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-APIMSGS" }, "C1MSGS1": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-C1MSGS1" } } }, "data": { "type": "array", "example": [ { "fieldName1": "string", "fieldName2": "string" }, { "fieldName1": "string", "fieldName2": "string" } ], "items": { "type": "object" } }, "messages": { "type": "string" } } }, "response200": { "type": "object", "properties": { "returnCode": { "type": "string", "example": "0000" }, "reasonCode": { "type": "string", "example": "0000" }, "reports": { "type": "object", "properties": { "APIMSGS": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-APIMSGS" }, "C1MSGS1": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-C1MSGS1" } } }, "data": { "type": "object", "example": "null" }, "messages": { "type": "string" } } }, "response400": { "type": "object", "properties": { "returnCode": { "type": "string", "example": "0012" }, "reasonCode": { "type": "string", "example": "0012" }, "reports": { "type": "object", "properties": { "APIMSGS": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-APIMSGS" }, "C1MSGS1": { "type": "string", "example": "http://localhost:8080/endevor/reports/0123456789-012345678-C1MSGS1" } } }, "data": { "type": "object", "example": "null" }, "messages": { "type": "string", "example": "error message" } } } } }
RESTful API Client Program Design Considerations
When you design your client program, the following points apply.
Setting Requests and Processing Responses
The RESTful API design model is an architectural style of web services that takes advantage of existing World Wide Web concepts and the HTTP protocol. Thus, there are many ways to use the model. The Web Services RESTful API requires the Jersey implementation of the JAX-RS specification. You can use the Jersey framework to develop client applications that are based on the RESTful API. However, you are free to use any applicable method for setting requests and processing responses.
Authentication
The RESTful API uses the HTTP basic access authentication method, which requires a user name and password when creating a request. When creating an HTTP request, the client program uses the Authorization header which is created in the following manner:
The username and password are combined into this string: "username:password".
The string is encoded using a Base64 encoding scheme. (Full specifications for the encoding scheme are contained in RFC 1421 and RFC 2045 - MIME (Multipurpose Internet Mail Extensions).)
The authorization method and space, for example, "Base" is placed before encoded credentials.
For example, if the user name is "ndvrusr" and the password is "mfpsswd" then the final header is as follows:
Authorization: Basic bmR2cnVzcjptZnBzc3dk
If the credentials are not valid, the "HTTP 401 Not Authorized" response code is returned.
Although the username and password are not humanly readable, this method does not encrypt credentials. To secure the communication, use HTTPS.
HTTPS
To ensure secure communication and encryption of the messages, configure, and use HTTPS. When working with HTTPS, ensure that the correct protocol and port are used. For more information about setting up HTTPS, see How to Configure Tomcat as HTTPS in the
Install and Set Up
CA Endevor
Web Services
article.
WADL
Jersey supports the Web Application Description Language (WADL). WADL is an XML description of the deployed RESTful web application. It contains the model of the resources, structure, supported media types, HTTP methods, and so on. It is similar to the Web Services Description Language (WSDL), which is used for the SOAP-based Web Services model. WADL can also be used for generating a client-side stub, however this feature is not as sophisticated as the stubs generated using the WSDL.
To list the WADL for the RESTful API, use following request:
http://<server>:<portnumber>/EndevorService/rest/application.wadl
RESTful API Outputs and Return Codes
After an action is submitted to
CA Endevor
, the user gets of the following returns:
Success:
{ "returnCode" : "####", "reasonCode" : "####", "data" : [] }
Error:
{ "returnCode" : "####", "reasonCode" : "####", "messages" : [ "Error Message" ] }
The returns use standard HTTP error code syntax. Any additional information is included in the body of the JSON-formatted response. The HTTP response codes correspond to the
CA Endevor
return codes as shown in this table:
CA Endevor
Return Code
HTTP Response Code
0000
200 OK
0004
206 Partial Content
0008
409 Conflict
0012
400 Bad Request
0016
500 Internal Server Error