Element Actions for RESTful API

The RESTful API processes the following Element-related actions:
ce18
The RESTful API processes the following Element-related actions:
 
 
Add Element Action
The Add Element action creates an element. To use this action, specify a POST method and use the URL with the element name at the end. Use a fully specified non-blank element name. If you specify the name of an element that already exists, you receive an error message. You must format the request as multipart/form-data.
For more information, see RFC 1867.
URL 
 
 
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
POST
Multipart
Required
Values
fromFile
Use this input to provide a source file for the ADD action.
Multipart
Required
Values
fromDSN
 
fromMember
 
fromPath
 
fromUSSFile
 
Use either fromDSN or fromMember, or fromPath or fromUSSFile to specify a source file or a member that is located on mainframe for the ADD action.
fromDSN/fromPath/fromFile
 are all mutually exclusive.
Multipart
Required
Values
fingerprint
 
Fingerprint is a 16-digit hex time stamp. Form data values as 
multipart/form-data
 plus one new optional value:
  • fingerprint=
    xxx
     
    where 
    xxx
     is the fingerprint of the Element version that is being replaced by this action.
CA Endevor
 checks whether the fingerprint matches, then performs the Add action accordingly.
Fingerprint can also have the value “NEW”, indicating that the element is not in 
CA Endevor
 yet. 
Multipart
Optional
Values
ccid
 
comment
 
You can enter a 1- to 12-character CCID and/or a 1- to 40-character comment.
CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the ADD action fails.
For an ADD action,
CA Endevor
treats the CCID and/or COMMENT fields differently depending on whether you are adding a new Element or an existing Element.
  • When you specify a CCID and/or comment in an ADD action for a new Element,
    CA Endevor
    uses this CCID and/or comment to:
    • Set the source and source delta CCID and/or COMMENT fields.
    • Set the last action CCID and/or COMMENT fields.
    • CA Endevor
      also clears the Environment entry Stage RETRIEVE CCID and/or COMMENT fields when you add a new Element.
  • When you specify a CCID and/or comment in an ADD action for an existing Element,
    CA Endevor
    uses this CCID and/or comment to:
    • Set the source CCID and/or COMMENT fields if the CCID and/or comment has changed.
    • Set the source delta CCID and/or COMMENT fields.
    • Set the last action CCID and/or COMMENT fields.
CA Endevor
also clears the Environment entry Stage RETRIEVE CCID and/or COMMENT fields when you add an existing Element.
Multipart
Optional
Values
oveSign 
 
(override sign out)
 
Possible Values = yes/no
If the Element has been signed out to a person other than yourself, you must code this option to perform this action. This option updates the signout ID at the appropriate Stage, with the user ID of the person performing the override.
Multipart
Optional
Values
newVersion
 
Value = version
If the New Version clause is omitted and the Element does not exist up the map, the Element is assigned version 1. Otherwise it will use the specified version.
Multipart
Optional
Values
generate
 
Possible values = yes/no
Specify whether you want the generate processor to be executed for the Element. By default, the generate processor is bypassed.
Multipart
Optional
Values
procGroup
Possible values = yes/no
Specifies whether to use a particular processor group for this action. If you do not specify a processor group, the system defaults to the processor group that is associated with the type to which the Element is assigned.
 
Example:
 
POST /EndevorService/rest/ENWSQA01/env/DEV/stgnum/1/sys/SYS/subsys/SUB/type/TXT/ele/newElement 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="ccid" ccidtest ------FormBoundary157e7090204 Content-Disposition: form-data; name="comment" comment test ------FormBoundary157e7090204 Content-Disposition: form-data; name="oveSign" yes ------FormBoundary157e7090204 Content-Disposition: form-data; name="fromFile"; filename="element.txt" Content-Type: text/plain ... contents of element.txt ... ------FormBoundary157e7090204--
Validate Fingerprints
URL
base URL
/
instance
/fingerprints
 
Method
PUT
(Required)
JSON
Parameters
action 
= validate
This parameter specifies the Validate Fingerprints Action to be executed.
(Required)
JSON
Parameters
fingerprints
 
This parameter contains a list of elements and their fingerprints
Here’s what you need to provide in the list
elmName
 
Element Name
envName
 
Environment Name
stgNum
 
Stage Number
sysName
 
System Name
sbsName
 
Sub-System Name
typeName
 
Element Type Name
fingerprint
 
Fingerprint=xxx
Update Element Action
The Update Element action updates an existing element. To use this action, specify a PUT method and use the URL with the Element name at the end. Use a fully specified non-blank element name. You must format the request as multipart/form-data.
For more information, see RFC 1867.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
PUT
Multipart
Required
Values
fromFile
 
Use this input to provide the source file for the UPDATE action.
Multipart
Required
Values
fromDSN
 
fromMember
 
fromPath
 
fromUSSFile
 
Use either fromDSN/fromMember or fromPath/fromUSSFile to specify the source file/member located on the mainframe for the UPDATE action.
fromDSN/fromPath/fromFile
 are all mutually exclusive.
Multipart
Required
Values
fingerprint
 
Fingerprint is a 16-digit hex time stamp. Form data values as 
multipart/form-data
 plus one new optional value:
  • fingerprint=xxx
    xxx is the fingerprint of the element version being replaced by this update. 
CA Endevor
 will check if fingerprint match, then perform the update action accordingly.
Multipart
Optional
Values
ccid
 
comment
 
You can enter a 1- to 12-character CCID and/or a 1- to 40-character comment.
CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the UPDATE action fails.
For an UPDATE action, 
CA Endevor
 treats the CCID and/or COMMENT fields differently depending on whether you are adding a new Element or an existing Element.
  • When you specify a CCID and/or comment in an UPDATE action for a new Element, 
    CA Endevor
     uses this CCID and/or comment to:
    • Set the source and source delta CCID and/or COMMENT fields.
    • Set the last action CCID and/or COMMENT fields.
    •  
      CA Endevor
       also clears the Environment entry Stage RETRIEVE CCID and/or COMMENT fields when you update an Element.
  • When you specify a CCID and/or comment in an UPDATE action for an existing Element, 
    CA Endevor
     uses this CCID and/or comment to:
    • Set the source CCID and/or COMMENT fields if the CCID and/or comment has changed.
    • Set the source delta CCID and/or COMMENT fields.
    • Set the last action CCID and/or COMMENT fields.
CA Endevor
also clears the Environment entry Stage RETRIEVE CCID and/or COMMENT fields when you update an existing Element.
Multipart
Optional
Values
oveSign 
 
(override sign out)
 
Possible Values = yes/no
If the Element has been signed out to a person other than yourself, you must code this option to perform this action. This option updates the signout ID at the appropriate Stage, with the user ID of the person performing the override.
Multipart
Optional
Values
generate
 
Possible values = yes/no
Specify whether you want the generate processor to be executed for the Element. By default, the generate processor is bypassed.
Multipart
Optional
Values
procGroup
Possible values = yes/no
Specifies whether to use a particular processor group for this action. If you do not specify a processor group and the Element to be updated is a new Element, the system defaults to the processor group that is associated with the type to which the Element is assigned.
If you do not specify a processor group and the Element to be updated already exists, the system defaults to the processor group that was last used for this Element.
Example:
PUT /EndevorService/rest/ENWSQA01/env/DEV/stgnum/1/sys/SYS/subsys/SUB/type/TXT/ele/newElement 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="ccid" ccidtest ------FormBoundary157e7090204 Content-Disposition: form-data; name="comment" comment test ------FormBoundary157e7090204 Content-Disposition: form-data; name="oveSign" yes ------FormBoundary157e7090204 Content-Disposition: form-data; name="fromFile"; filename="element.txt" Content-Type: text/plain ... contents of element.txt ... ------FormBoundary157e7090204--
Retrieve Element Action
The Retrieve Element action retrieves an existing element. To use this action, specify a GET method and use the URL with the element name at the end. You need to specify Accept header statement with application/octet-stream. Use a fully specified non-blank element name. All other parameters are query parameters.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
GET
Accept (Required)
application/octet-stream
(Optional) Query Parameters
version
 
level
 
Indicates the version and level number that you want to retrieve. Acceptable version numbers are 
1-99
. Acceptable level numbers are
 
 
00-99
. By default, information for the current version level is retrieved.
Parameters 
version
 and 
level
 must be specified together.
(Optional) Query Parameters
toDSN
 
toMember
 
toPath
 
toUSSFile
 
Use either toDSN/toMember or toPath/toUSSFile to specify member/file located on mainframe where the source of the element will be retrieved.
 
toDSN/toPath
 are all mutually exclusive.
If neither of these parameters are specified, you will receive the source in body of the response as an application/octet-stream.
(Optional) Query Parameters
ccid
 
comment
 
You can enter a 1- to 12-character CCID and/or a 1- to 40-character comment. CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the RETRIEVE action fails.
When you specify a CCID and/or comment in a RETRIEVE action for an existing Element,
CA Endevor
uses this CCID and /or comment to set the RETRIEVE CCID and/or COMMENT fields.
(Optional) Query Parameters
oveSign 
 
(override sign out)
 
Possible Values = yes/no
If the Element has been signed out to a person other than yourself, code this option to perform this action. Use oveSign with caution to avoid regressing changes that are made by another user.
(Optional) Query Parameters
noSignout
 
Possible Values = yes/no
This option is applicable only if SIGNIN/SIGNOUT is in effect for the System. Parameter noSignout enables the Element to be retrieved without signing it out; that is, if you select this option, the Element is not signed out to your user ID. This option enables another user to retrieve the Element while you are working with it.
Similarly, if you want to use an Element currently signed out to another user, you can retrieve a copy of it if that user has selected the noSignout option.
If you use noSignout, any ccids and comments are ignored. The Master Control File is not updated
(Optional) Query Parameters
search
 
Possible Search = yes/no 
Tells
CA Endevor
to look for the Element to be retrieved along the map, if it is not in the current Environment. The default is search=no.
Search=no to restrict
CA Endevor
search to the current Environment.
(Optional) Query Parameters
replaceMember
 
Possible Values = yes/no
If you retrieve an Element to a dataset/USS path,
CA Endevor
checks to see whether that Element is currently in the library. By default, if this condition exists, the request is rejected.
The replaceMember parameter, however, enables you to replace the member currently in the library (file in the path) with the retrieved Element. Specify this option when you want to replace the existing member in the library.
(Optional) Query Parameters
expandIncludes
 
Possible Values = yes/no
Indicates that INCLUDE statements should be expanded when the Element is retrieved.
In addition, the Type definition for this Element must specify an INCLUDE library.
(Optional) Query Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to that Element that matches one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCIDs. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, "TEST.LIB"
(Optional) Query Parameters
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
(Optional) Query Parameters
toDDN
Specifies the DDname to which the Print result is directed. 
Print Element Action
The Print Element action prints selected information about Elements.
You can request the following information about Elements:
  • BROWSE (the default) prints all statements in the specified level of the Element, as well as the level at which each statement was inserted.
  • CHANGES shows all inserts and deletes made to the Element at the level specified.
  • HISTORY prints all statements in all levels of the Element.
  • SUMMARY prints one line of summary information for each level.
  • MASTER prints Master Control File information for the Element.
  • LISTING prints the output listing for the Element. ACM is required.
To use this action, specify a GET method and use the URL with the element name at the end. You need to specify Accept header statement with text/plain. Use a fully specified non-blank element name. All other parameters are query parameters and are optional.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
GET
Accept (Required)
text/plain
(Optional) Query Parameters
version
 
level
 
Indicates the version and level number that you want to print. Acceptable version numbers are 
1-99
. Acceptable level numbers are
 00-99
. By default, information for the current version level is printed. VERSION and LEVEL must be specified together.
(Optional) Query Parameters
print 
 
Possible values = browse/changes/history/summary/master/listing
  • BROWSE | CHANGES | HISTORY | SUMMARY | MASTER | LISTING
    BROWSE is the default.
    • BROWSE
      Prints the current Element source, indicating the level at which each line was added. If you specify a particular level,
      CA Endevor
      prints the source for that level. The Default.
    • CHANGES
      Prints all the changes-inserts and deletes-made to the Element at the level specified. If you do not specify a level in the LEVEL clause, changes for the current level of the Element are shown.
    • HISTORY
      Prints all lines that have ever been in the Element source, noting the level at which the line was added, changed, or deleted. If you specify a level in the LEVEL clause,
      CA Endevor
      prints history for that level.
    • SUMMARY
      Prints a summary line of data for each level of the Element, and includes information appropriate to that level (for example, the number of inserts and the number of deletes).
    • MASTER
      Prints Master Control File information that is stored for the selected Element, and the BROWSE data, which is the current data pertaining to that Element (such as last Processor, Processor return codes, current version or level.)
    • LISTING 
      Prints the Element associated output listing. The 
      CA Endevor
      Automated Configuration Option
       is required. The default value for the LISTING option is LIST. If you want to use the default value, then do 
      not
       specify listString (check the next option). You can override the default by changing the C1DEFLTS parameter COMPLISTWD=, which defines the site-wide component listing string ID. If you code the LISTING option, do not code the noHeadings=yes as it results in a syntax error.
    The BROWSE, CHANGES, HISTORY, SUMMARY, MASTER and LISTING printouts provide the same information as their corresponding online panels.
    The Element BROWSE, CHANGE, HISTORY and SUMMARY options are not supported on sourceless Elements. When encountered, the action is skipped and an information message is written to the action log. The MASTER option is supported for both sourced and sourceless Elements.
(Optional) Query Parameters
search
 
Possible Values = yes/no
Tells
CA Endevor
to look and print all occurences of the Element on the map. The default is search=no.
Search=no restrict
CA Endevor
search to the current Environment.
(Optional) Query Parameters
noHeadings
 
Possible Values = yes/no
If coded yes, suppresses the default printing of a header on each page of output. For the PRINT ELEMENT MASTER output, other line feed characters in column 1 of the output are replaced with a blank space.
(Optional) Query Parameters
explode
 
Possible Values = yes/no
Prints the input component information that is extracted from the ACMQ files (ACMROOT and ACMXREF), for the specified Element. 
(Optional) Query Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to the Element that matches one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCIDs. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, TEST"."LIB
(Optional) Query Parameters
 
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
(Optional) Query Parameters
toDDN
Specifies the DDname to which the Print result is directed. 
Print Element Components Action
The Print Element Components action prints selected component information about Elements. The 
CA Endevor
Automated Configuration
 option is required to use this action.
To use this action, specify a GET method and use the URL with the element name and components keyword at the end. Use a fully specified non-blank element name. All other parameters are query parameters and are optional.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
/components
 
Method
GET
Accept
(Optional)
text/plain
(Optional)
Query
Parameters
version
 
level
 
Indicates the version and level number that you want to print. Acceptable version numbers are 
1-99
. Acceptable level numbers are
 00-99
. By default, information for the current version level is printed. VERSION and LEVEL must be specified together.
(Optional)
Query
Parameters
 
print 
 
Possible values = browse/changes/history/summary
  • BROWSE | CHANGES | HISTORY | SUMMARY
    BROWSE is the default.
    • BROWSE
      Prints the current component list source, indicating the level at which each line was added. The Default.
       
    • CHANGES
      Prints all the changes-inserts and deletes-made to the component list at the level specified. If you do not specify a level in the LEVEL clause, changes for the current level of the Element are shown.
    • HISTORY
      Prints all lines that have ever been in the component list source, noting the level at which the line was added, changed, or deleted. If you specify a level in the LEVEL clause,
      CA Endevor
      prints history for that level.
    • SUMMARY
      Prints a summary line of data for each level of the component list, and includes information appropriate to that level (for example, the number of inserts and the number of deletes). 
CA Endevor
prints as much information as is available for the component list. For example, if you code COMPONENTS CHANGES but there were no changes to the output components section, that section would not appear in the associated listing.
The BROWSE, CHANGES, HISTORY, SUMMARY printouts provide the same information as their corresponding online panels.
The Element BROWSE, CHANGE, HISTORY and SUMMARY options are not supported on sourceless Elements. When encountered, the action is skipped and an information message is written to the action log.
(Optional)
Query
Parameters
search
 
Possible Values = yes/no
Tells
CA Endevor
to look and print all occurences of the Element on the map. The default is search=no.
Search=no restrict
CA Endevor
search to the current Environment.
(Optional)
Query
Parameters
 
noHeadings
 
Possible Values = yes/no
If coded yes, suppresses the default printing of a header on each page of output. For the PRINT ELEMENT MASTER output, other line feed characters in column 1 of the output are replaced with a blank space.
(Optional)
Query
Parameters
explode
 
Possible Values = yes/no
Prints the input component information that is extracted from the ACMQ files (ACMROOT and ACMXREF), for the specified Element.
(Optional)
Query
Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to that Element that match one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCIDs. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, TEST"."LIB
(Optional)
Query
Parameters
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
(Optional) Query Parameters
toDDN
Specifies the DDname to which the Print result is directed. 
Generate Element Action
The Generate action executes the generate Processor for the current level of an Element, in Stage 1 or Stage 2.
To use this action, specify a PUT method and use the URL with the element name at the end. Use JSON data in request body for parameters.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
PUT
(Required)
JSON
Parameters
action 
= generate
This parameter specify Generate Element Action to be executed.
(Optional)
JSON
Parameters
ccid
 
comment
 
You can enter a 1- to 12-character CCID and/or a 1- to 40-character comment. CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the GENERATE action fails.
When you specify a CCID and/or comment in a GENERATE action,
CA Endevor
updates the CCID and/or COMMENT fields differently, depending on whether you specify the GENERATE action with or without the copyBack option.
 When you specify a CCID and/or comment in a GENERATE action without the copyBack option (or copyBack=no),
CA Endevor
uses this CCID and/or comment to:
  • Set the generate CCID and/or COMMENT fields.
  • Set the last action CCID and/or COMMENT fields.
  • Set the component list delta CCID and/or COMMENT fields if running the generate Processor creates a change.
When you specify a CCID and/or comment in a GENERATE action with the option copyBack=yes,
CA Endevor
uses this CCID and/or comment to:
  • Set the generate and component list delta CCID and/or COMMENT fields.
  • Set the last action CCID and/or COMMENT fields.
CA Endevor
also uses the CCID and comment associated with the copied-back Element to set the source and source delta CCID and/or COMMENT fields when you generate that Element using the option copyBack=yes.
(Optional)
JSON
Parameters
oveSign 
 
(override sign out)
 
Possible Values = yes/no
If the Element has been signed out to a person other than yourself, code this option to perform this action. This option updates the SIGNOUT ID at the appropriate Stage with the user ID of the person performing the override. Use oveSign with caution to avoid regressing changes that are made by another user.
(Optional)
JSON
Parameters
copyBack
 
Possible Values = yes/no
If you select this option,
CA Endevor
first copies the current level of the Element back to the FROM Stage, then generates the Element.
CA Endevor
searches for the Element first in the current Environment, then in other stages along the map.
If the Element currently exists in the FROM Stage,
CA Endevor
ignores the option copyBack=yes and simply generates the Element.
Option copyBack=yes cannot be used with noSource=yes.
(Optional)
JSON
Parameters
search
 
Possible Values = yes/no
This option is valid only when you have specified the option copyBack=yes. The SEARCH option tells
CA Endevor
to look for the Element to be generated with copyback along the map, if it is not in the current Environment.
Code search=no to restrict the search to the current Environment.
(Optional)
JSON
Parameters
noSource
 
Possible Values = yes/no
When the target location has a sourced Element, the Element is generated in place.
When the target location has a sourceless Element, the Element is generated at the target location using the source of the first occurrence of the Element found up the map.
When the Element does not exist at the target location, the Element is generated at the target location using the source of the first occurrence of the Element found up the map. The source is not fetched to the target. The MCF Element that is created at the target location contains data similar to a fetched back Element except that the Element base and delta name fields are blank and the record is marked as a sourceless Element.
Option noSource=yes cannot be used with copyBack=yes.
(Optional)
JSON
Parameters
procGroup
 
Select this option to specify a predefined, named group of Processors.
If you do not specify a Processor group,
CA Endevor
defaults to the Processor group last used for this Element.
(Optional)
JSON
Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to that Element that matches one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCID. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, TEST"."LIB
(Optional)
JSON
Parameters
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
PUT /EndevorService/rest/ENWSQA01/env/DEV/stgnum/1/sys/SYS/subsys/SUB/type/TXT/ele/newElement HTTP/1.1 Host: localhost:8080 Authorization: Basic VVNFUk0yOkhhbHV1eg== Content-Type: application/json Content-Length: 64 {"action":"generate","ccid":"ccidtest","comment":"commenttest"}
Move Element Action
The Move action moves Elements between inventory locations along a map.
To use this action, specify a PUT method and use the URL with the element name at the end. Use JSON data in request body for parameters.
URL
 
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
PUT
(Required)
JSON
Parameters
action 
= move
This parameter specify Move Element Action to be executed.
(Optional)
JSON
Parameters
ccid
 
comment
 
You can enter a 1- to 12-character CCID and/or a 1- to 40-character comment. CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the MOVE action fails.
When you specify a CCID and/or comment in a MOVE action,
CA Endevor
updates the CCID and/or COMMENT fields differently, depending on whether you specify the MOVE action withHistory yes or no.
When you specify a CCID and/or comment in a MOVE action withHistory=no,
CA Endevor
uses this CCID and/or comment to set the last action CCID and/or COMMENT fields.
CA Endevor
also:
  • Sets the source and generate CCID and/or COMMENT fields to their value at the source location of the move.
  • Sets the source and component list delta CCID and/or COMMENT fields to their last value at the source location of the move.
  • Clears the retrieve CCID and/or COMMENT field.
When you specify a CCID and/or comment in a MOVE action using the option withHistory=yes,
CA Endevor
uses this CCID and/or comment to set the last action CCID and/or COMMENT fields.
 
CA Endevor
also does the following:
  • Sets the source and generate CCID and/or COMMENT fields to their value at the source location of the move.
  • Clears the retrieve CCID and/or COMMENT fields.
  • Moves source delta CCIDs and comments with their respective delta levels.
  • Moves the current version/level of the Component List.
(Optional)
JSON
Parameters
sync 
 
(synchronize)
 
Possible Values = yes/no
The synchronize option compensates for differences between the base level of a source Element and the current level of a target Element.
CA Endevor
attempts to find a sync level between the source and target Elements, beginning with the first level at the source, and working forward through the deltas. If
CA Endevor
finds a sync level, it compares the two and creates a new level at the target that reflects the differences. If
CA Endevor
cannot find a sync level and you specify sync=yes,
CA Endevor
issues an out of sync message.
CA Endevor
then compares the last level of the source and last level of the target, and creates a new level at the target that reflects the differences.
When moving with history, if the sync point is found,
CA Endevor
moves the Element from the FROM location to the TO location, appending the FROM location delta levels after the sync-point Element. If the two levels are different and if sync=yes is specified,
CA Endevor
first creates a sync level at the target reflecting the differences between the base level of the FROM Element and the target, then moves the Element to the TO location and appends the FROM location delta levels to the target.
(Optional)
JSON
Parameters
withHistory
 
Possible Values = yes/no
The withHistory=yes option preserves source Element change history. If you request MOVE withHistory=yes,
CA Endevor
first ensures that the current level of the target Element is the same as the base level of the source Element. It then moves all levels of the Element from source to target, appending the source change history to the target change history.
If you do not code this option (or withHistory=no),
CA Endevor
moves the Elements without history. When you move the Element without history
CA Endevor
searches through the Element levels at the source location to find a matching level at the target location.
CA Endevor
then compares the two and creates a new level at the target location that reflects the differences.
If the base level of the source Element differs from the current level at the target, the move fails unless you code the option sync=yes.
(Optional)
JSON
Parameters
bypassElementDelete
 
Possible Values = yes/no
Tells
CA Endevor
to retain the Element in the source Stage after successfully completing the move.
(Optional)
JSON
Parameters
retainSignOut
 
Possible Values = yes/no
This option tells
CA Endevor
to retain the source location signouts for all Elements at the target location. This option applies only if the Element was signed out at the target before the MOVE.
  • If the Element was signed out at the target before the MOVE, it is signed out to that same ID-at the target-after the MOVE.
  • If the Element was not signed out at the target before the MOVE, it will not be signed out at the target after the MOVE.
  • If you do not use this option, the Element at the target location is not signed out, regardless of whether it was signed out at the target before the MOVE took place.
The default behavior, when retainSignOut or signOutTo is not specified, is to sign in all Elements at the target Stage after successfully completing the move
(Optional)
JSON
Parameters
signOutTo
 
Tells
CA Endevor
to sign all Elements out to the specified user ID at the target Stage.
(Optional)
JSON
Parameters
 
jump
 
Possible Values = yes/no
The JUMP option tells
CA Endevor
to move Elements across Environments even if the Element exists at an intermediate Stage that is not on the map. If the Element exists at an intermediate Stage, the move fails if REQ ELM JUMP ACKNOWLEDGE=Y at the System level and the JUMP option is not coded.
(Optional)
JSON
Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to that Element that match one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCIDs. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, TEST"."LIB
(Optional)
JSON
Parameters
 
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
PUT /EndevorService/rest/ENWSQA01/env/DEV/stgnum/1/sys/SYS/subsys/SUB/type/TXT/ele/newElement HTTP/1.1 Host: localhost:8080 Authorization: Basic VVNFUk0yOkhhbHV1eg== Content-Type: application/json Content-Length: 64 {"action":"move","ccid":"ccidtest","comment":"commenttest"}
Transfer Element Action
The Transfer action transfers Elements from one
CA Endevor
location to another.
To use this action, specify a PUT method and use the URL with the element name at the end. Use JSON data in request body for parameters.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
PUT
(Required)
Content-Type
application/json
(Required)
JSON
Parameters
action=transfer
This parameter specifies whether the Transfer Element Action is executed.
(Required) JSON Parameters 
toEnvironment
 
You can enter a 1- to 8-character Environment destination where you want to transfer the element. The target environment value must be explicitly coded. This field is required. 
(Optional)
JSON
Parameters
version
 
level
 
Indicates the version and level number you want to transfer. If you want to indicate a version and level, code a full Element name. Acceptable Version numbers are 
1-99
. Acceptable Level numbers are 
00-99
. Parameters 
version
 and 
level
 must be specified together.
If you do not specify a VERSION LEVEL clause, the TRANSFER action transfers all levels to the target location. If you specify this clause, only the VERSION LEVEL you indicate gets transferred.
If the specified version level is not the current level, the generate Processor executes at the target location, regardless of the Processor group definition setting.
(Optional)
JSON
Parameters
ccid
 
comment
 
You can enter a 1- to 12-character CCID and/or a 1- to 40-character comment. CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the TRANSFER action fails.
When you specify a CCID and/or comment in a TRANSFER action,
CA Endevor
updates the CCID and/or COMMENT fields differently, depending on whether you specify the TRANSFER action withHistory yes or no.
When you specify a CCID and/or comment in a TRANSFER action withHistory=no,
CA Endevor
uses this CCID and/or comment to set the last action CCID and/or COMMENT fields.
CA Endevor
also:
  • Sets the source and generate CCID and/or COMMENT fields to their value at the source location of the move.
  • Sets the source and component list delta CCID and/or COMMENT fields to their last value at the source location of the move.
  • Clears the retrieve CCID and/or COMMENT field.
When you specify a CCID and/or comment in a TRANSFER action using the option withHistory=yes,
CA Endevor
uses this CCID and/or comment to set the last action CCID and/or COMMENT fields.
CA Endevor
also does the following:
  • Sets the source and generate CCID and/or COMMENT fields to their value at the source location of the move.
  • Clears the retrieve CCID and/or COMMENT fields.
  • Moves source delta CCIDs and comments with their respective delta levels.
  • Moves the current version/level of the Component List. 
(Optional) JSON Parameters 
toStageNum
 
You can enter either 1 or 2 for the Stage Number destination where you want to transfer the element. This field is required. 
(Optional) JSON Parameters 
toSystem
 
You can enter a 1- to 8-character System destination where you want to transfer the element. If the target System name is fully wildcarded, the target System will be the same than the one that appears in the URL of your request. This field is required. 
(Optional) JSON Parameters 
toSubsystem
 
You can enter a 1- to 8-character Subsystem destination where you want to transfer the element. If the target Subsystem name is fully wildcarded, the target Subsystem will be the same than the one that appears in the URL of your request. This field is required. 
(Optional) JSON Parameters 
toType
 
You can enter a 1- to 8-character Type destination where you want to transfer the element. If the target Type name is fully wildcarded, the target Type will be the same than the one that appears in the URL of your request. This field is required. 
(Optional) JSON Parameters 
toElement
 
You can enter a different target Element name if you want to change the Element name specified in the URL of your request. If you do not enter an Element name here,
CA Endevor
® SCM assigns the same target Element name than the one that appears in the URL of the request.
(Optional)
JSON
Parameters
sync 
 
(synchronize)
 
Possible Values = yes/no
The synchronize option compensates for differences between the base level of a source Element and the current level of a target Element.
CA Endevor
attempts to find a sync level between the source and target Elements, beginning with the first level at the source, and working forward through the deltas. If
CA Endevor
finds a sync level, it compares the two and creates a new level at the target that reflects the differences. If
CA Endevor
cannot find a sync level and you specify sync=yes,
CA Endevor
issues an out of sync message.
CA Endevor
then compares the last level of the source and last level of the target, and creates a new level at the target that reflects the differences.
When transfering with history, if the sync point is found,
CA Endevor
moves the Element from the FROM location to the TO location, appending the FROM location delta levels after the sync-point Element. If the two levels are different and if sync=yes is specified,
CA Endevor
first creates a sync level at the target reflecting the differences between the base level of the FROM Element and the target, then moves the Element to the TO location and appends the FROM location delta levels to the target.
(Optional)
JSON
Parameters
withHistory
 
Possible Values = yes/no
The withHistory=yes option preserves source Element change history. If you request TRANSFER withHistory=yes,
CA Endevor
first ensures that the current level of the target Element is the same as the base level of the source Element. It then moves all levels of the Element from source to target, appending the source change history to the target change history.
If you do not code this option (or withHistory=no),
CA Endevor
moves the Elements without history. When you move the Element without history
CA Endevor
searches through the Element levels at the source location to find a matching level at the target location.
CA Endevor
then compares the two and creates a new level at the target location that reflects the differences.
If the base level of the source Element differs from the current level at the target, the move fails unless you code the option sync=yes.
(Optional)
JSON
Parameters
newVersion
 
Value = version
By default, the version number of the FROM location Element-at the time it is transferred-is assigned to the TO location Element. Use this option to assign a different version number to the TO location Element; simply enter the number (1-99) inclusive, leading zeros optional) that you want to use.
CA Endevor
allows only one version of an Element at each location. Therefore, if the Element currently exists at the target location, you cannot update it with another version. For example, if you try to transfer Version 2 of an Element to a target location that already has an existing Version 1, you must archive or delete the current Version 1 before you transfer the Version 2. If the Element exists at the target location or at a location up the mapped route, the TRANSFER action fails.
(Optional)
JSON
Parameters
procGroup
 
Value = processor group
Select this option to specify a predefined group of Processors. If you do not specify a Processor group,
CA Endevor
defaults to the Processor group last used for this Element. However, the parameters procGroup and bypassGenerateProc are mutually exclusive (you can code one or the other). If both are coded, the default bypassGenerateProc is used.
If the FROM Element is associated with a Processor group that does not specify bypassGenerateProc, the Processor group may be overridden with the procGroup parameter. Otherwise, a message will be issued saying that the Processor group cannot be overridden.
(Optional)
JSON
Parameters
ignoreGenerateFailed
 
Possible Values = yes/no
This option applies to the *FAILED* flag previously set for the Element. If the TRANSFER action is unsuccessful, you receive a message indicating that "the generate failed." Processing for the action normally is terminated at this point.
If you enter this option, however, you can perform the action whether or not the Element was previously generated or moved successfully. 
(Optional)
JSON
Parameters
bypassElementDelete
 
Possible Values = yes/no
This option tells
CA Endevor
to retain the Element in the FROM location after it is transferred. When you select this option, the delete Processor is also bypassed.
(Optional)
JSON
Parameters
bypassDeleteProc
 
Possible Values = yes/no
If you select this option,
CA Endevor
does not execute the delete Processor.
(Optional)
JSON
Parameters
bypassGenerateProc
 
Possible Values = yes/no
Select this option if you do not want the generate/move Processor (depending on the Processor group option chosen) executed for the Element.
(Optional)
JSON
Parameters
retainSignOut
 
Possible Values = yes/no
This option tells
CA Endevor
to retain the source location signouts for all Elements at the target location. This option applies only if the Element was signed out at the source before the TRANSFER.
  • If the Element was signed out at the target before the TRANSFER, it is signed out to that same ID-at the target-after the TRANSFER.
  • If the Element was not signed out at the target before the TRANSFER, it will not be signed out at the target after the TRANSFER.
  • If you do not use this option, the Element at the target location is not signed out, regardless of whether it was signed out at the target before the TRANSFER took place.
The default behavior, when retainSignOut or signOutTo is not specified, is to sign in all Elements at the target Stage after successfully completing the move
(Optional)
JSON
Parameters
signOutTo
 
Tells
CA Endevor
to sign all Elements out to the specified user ID at the target Stage.
(Optional)
JSON
Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to that Element that matches one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCIDs. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, TEST"."LIB
(Optional)
JSON
Parameters
 
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
PUT /EndevorService/rest/ENWSQA01/env/DEV/stgnum/1/sys/SYS/subsys/SUB/type/TXT/el e/newElement HTTP/1.1 Host: localhost:8080 Authorization: Basic VVNFUk0yOkhhbHV1eg== Content-Type: application/json Content-Length: 64 {"action":"transfer","ccid":"ccidtest","comment":"commenttest","toEnvironment ":"Dev","toStageNum":"2","toSystem":"SYS","toSubsystem":"SUB","toType":"TXT"}
Signin Element Action
To use this action, specify a PUT method and use the URL with the element name at the end. Use JSON data in request body for parameters.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
PUT
(Required)
JSON
Parameters
action 
= signin
This parameter specify Signin Element Action to be executed.
(Optional)
JSON
Parameters
oveSign 
 
(override sign out)
 
Possible Values = yes/no
If the Element has been signed out to a person other than yourself, code this option to perform this action. Use oveSign parameter with caution to avoid regressing changes that are made by another user.
(Optional)
JSON
Parameters
search
 
Possible Values = yes/no
The search=no parameter tells
CA Endevor
to restrict its search to the current Environment. The default is search=no parameter. Code search=yes to tell
CA Endevor
to look for the Element to be signed in along the map, if it is not in the current Environment.
(Optional)
JSON
Parameters
signOutTo
 
Enables you to sign out or reassign an Element at either Stage to another user. If you have an Element signed out to your user ID, you can use this option to reassign that Element to the other user.
(Optional)
JSON
Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to that Element that matches one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCIDs. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, TEST"."LIB
(Optional)
JSON
Parameters
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
Delete Element Action
The Delete action deletes an Element and/or Components from the specified inventory location.
When deleting a sourced Element, if a prior sourceless Element exists and if no other sourced Element exists upstream from the delete location, the action fails. The action cannot be allowed if there is no sourced instance of the Element upstream from a sourceless Element. This action would make a regeneration of a sourceless Element impossible.
To use this action, specify a DELETE method and use the URL with the element name at the end. Use query parameters for additional options.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
 
 
Method
DELETE
(Optional)
Query
Parameters
ccid
 
comment
 
You can enter a 1- to 12- character CCID and/or a 1- to 40-character comment.
CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the Delete action fails.
(Optional)
Query
Parameters
oveSign 
 
(override sign out)
 
Possible Values = yes/no
If the Element has been signed out to a person other than yourself, code this option to perform this action. This option updates the SIGNOUT ID at the appropriate Stage with the user ID of the person performing the override. Use OVERRIDE SIGNOUT with caution to avoid regressing changes that are made by another user.
(Optional)
Query
Parameters
onlyComponents
 
Possible Values = yes/no
Applicable for
CA Endevor
ACM users only. Indicates whether you want to delete both the Element component list and the Element, or the Element component list only. Yes (yes-delete just the Element component list) or No (no-delete the Element and the Element component list). No is the default option.
(Optional)
Query
Parameters
whereCcidCurrent
 
whereCcidAll
 
whereCcidRetrieve
 
Limits the processing to that Element that matches one of the supplied CCIDs. You can use a name-mask in this field.
  • whereCcidCurrent
    Tells
    CA Endevor
    to look through the CCID fields in the Master Control File to find a specified CCIDs. Default.
  • whereCcidAll
    Tells
    CA Endevor
    to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs. If you have ACM,
    CA Endevor
    also searches the COMPONENT LIST DELTA levels for the specified CCIDs. If the Element is sourceless, the source Element delta level CCID checks are not done.
  • whereCcidRetrieve
    Tells
    CA Endevor
    to use the CCID in the Master Control File RETRIEVE CCID field.
  • All the whereCcid
    xxx
     options are exclusive. You can't use more than one whereCcid
    xxx
     option at the same time.
  • You can specify up to eight CCIDs in a whereCcid
    xxx
     option, separated by commas.
  • If you use special characters in the CCIDs inside a whereCcid
    xxx
     option, follow the SCL syntax convention and enclose these CCIDs in quotes.
    Example: Period (.) Special Character in CCID in whereCcid
    xxx
     Option
    ccid1, ccid2, TEST"."LIB
(Optional)
Query
Parameters
whereProcGroup
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas. 
(Optional)
Query
Parameters
fingerprint
 
Fingerprint is a 16-digit hex time stamp.
Example: 
fingerprint=xxx
where xxx is the fingerprint of the element version being deleted. 
CA Endevor
 checks whether the fingerprints match, then performs the Delete action accordingly.
List Elements
The list Elements function lets you extract Element information from the Master Control File that satisfies the criteria you specify. You have to specify Accept header statement. 
URL
base URL/instance/
env
/environment/
stgnum
/stage number/
sys
/system/
subsys
/subsystem/
type
/type/
ele
/element
 
Method
GET
Accept (Required)
application/json
Parameters
data = ALL/BAS/ELE
 
(Optional) If not specified, the default is DATA ALL. However, DATA ALL does not return change level summary data. DATA BAS writes basic summary and DATA ELE writes Element summary.
path = LOG/PHY
 
PATH LOGICAL and PATH PHYSICAL option
N/A
search = NOS/SEA
 
SEARCH and NOSEARCH option
N/A
return = FIR/ALL
 
RETURN FIRST or RETURN ALL option
The PATH, SEARCH, NOSEARCH, and RETURN clauses can be omitted. Default mapping options on nonexplicit Environment name requests are: PATH PHYSICAL, NOSEARCH, and RETURN ALL. The PATH LOGICAL, SEARCH, and RETURN FIRST clauses are invalid on nonexplicit Environment name requests. Default mapping options on explicit Environment name requests are: PATH LOGICAL, RETURN FIRST, and NOSEARCH.
Name masking is allowed for all parameters (Environment, Stage, System, Subsystem, Type, Element). 
CA Endevor
 limits the length of Environment, of System, and of Subsystem to 8 characters.
Output
List of Elements in JSON format, which corresponds to the 
CA Endevor
 List Element function of the CSV utility.
(Optional) Query Parameters
whereCcidCurrent
 
whereCcidGen
 
whereCcidLastAct
 
whereCcidLastlvl
 
whereCcidChange
 
whereCcidRetrieve
 
Limits the processing to that Element that matches one of the supplied Change Control Identifiers (CCIDs). You can use a name-mask in this field.
  • whereCcidCurrent
     
      
    Accepts values that are specified against the Last Action, Generate, and Last Level CCIDs that are associated with an Element. 
  • whereCcidGen
     
      
    Accepts values that are specified against the Generate CCID that is associated with an Element. 
  • whereCcidLastAct
     
      
    Accepts values that are specified against the Last Action CCID that is associated with an Element.
  • whereCcidLastlvl
    Accepts values that are specified against the Last Level CCID that is associated with an Element.
  • whereCcidChange
    Filters the results of the list data summary function that is based on the specified CCIDs.
  • whereCcidRetrieve
    Accepts values that are specified against the Last Retrieve action CCID that is associated with an Element. 
To select Elements that are identified under more than one CCID, you can specify multiple CCIDs by separating them with commas.
The whereCcid
xxxxx
 parameters are mutually exclusive. Only one parameter is used for the Delete action.
(Optional)
Query
Parameters
whereProcGroup
 
Lets you select Elements according to a specified Processor group. You can use a name-mask when specifying the Processor group name.
To select Elements identified under more than one Processor group, you can specify multiple distinct Processor group selectors by separating them with commas.
(Optional)
Query
Parameters
whereProcType
 
Lets you select Elements according to a specified Processor type. You can use a name-mask when specifying the Processor type name.
To select Elements identified under more than one Processor type, you can specify multiple distinct Processor type selectors by separating them with commas.
List Components Used by Element Function
This function lets you list the components that are in use by the Element that you specify.
URL
base URL
/
instance
/env/
environment
/stgnum/
stage number
/sys/
system
/subsys/
subsystem
/type/
type
/ele/
element
/acm
Method
GET
Accept (Required)
application/json
(Optional) Query Parameters
excCirculars
Filters the ACM data to exclude components that have a circular relationship to the object of your search.
Values:
 yes/no
Default:
 no
(Optional) Query Parameters
excIndirect
 (override sign out)
Filters the ACM data to exclude indirectly related components.
Values:
 yes/no
Default:
 no
(Optional) Query Parameters
excRelated
Filters the ACM data to exclude related components.
Values:
 yes/no
Default:
 no