Available Xactly Connect APIs

Naga Sri Hari Gonaboyina

Updated November 25, 2024 20:07

When you configure an export, import, other type of flow step using the prebuilt Xactly Connect connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Xactly Connect API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Audits	Get a paginated list of all audit records	X
Credentials	Get a paginated list of all credential definitions	X
	Create a credential definition		X
	Get a single credential definition	X
	Update a credential definition		X
	Delete a credential		X
	Validate the given credential entity	X
	Gets the credential history	X
	Compare two credential definitions	X
Cursors	Get a paginated list of all cursor definitions	X
Cursors	Delete a cursor		X
Debug state	Get the current debug state	X
	Cancel the debug state		X
	Pause the debug state		X
	Create a debug state		X
	Cancel the debug state		X
	Run the debug state		X
	Run to some named object in the current debugged pipeline		X
	Step over the next member in the debug state		X
	Step into the next pipeline in the debug state		X
	Step out of the current pipeline being debugged		X
Deploy containers	Get a paginated list of all deploy containers definitions	X
	Create a deploy container definition		X
	Get a single deployment container definition	X
	Update a deploy container definition		X
	Delete a deploy container		X
	Gets the container history	X
	Compare two deploy container definitions	X
Deployments	Get a paginated list of all deployment definitions	X
	Send deployment(delta domain objects) to remote Xactly Connect service		X
	Get the latest deployment definition	X
	Send request to get available source environments for deploy process	X
	Send request to get available target environments for deploy process	X
	Get a single deployment definition	X
	Delete a deployment record		X
	Compare two deployment definitions	X
Emails	Get a paginated list of all email definitions	X
	Create an email definition		X
	Get a single email definition	X
	Update an email definition		X
	Delete a email		X
	Send the email		X
	Get a single email definition versions	X
	Compare two email definitions	X
Files	Retrieve the contents of the file at the given path	X
	Upload a file to the given path		X
	Delete the file at the given path		X
	Retrieve the list of full paths for the files and directories under the given path	X
Invocations	Get a paginated list of all invocations	X
Invocations	Get a single invocation object	X
Iterators	Get a paginated list of all iterator definitions	X
	Create an iterator definition		X
	Get a single iterator definition	X
	Update an iterator definition		X
	Delete a iterator		X
	Invoke (run) a iterator		X
	Get a single iterator definition versions	X
	Compare two iterator definitions	X
Pipelines	Get a paginated list of all pipeline definitions	X
	Create a pipeline definition		X
	Get a single pipeline definition	X
	Update a pipeline definition		X
	Delete a pipeline		X
	Invoke (run) a pipeline		X
	Get a single pipeline definition versions	X
	Compare two pipeline definitions	X
Schedules	Get a paginated list of all schedule definitions	X
	Create a schedule definition		X
	Get a single schedule definition	X
	Update a schedule definition		X
	Delete a schedule		X
	Get a single schedule definition versions	X
	Compare two schedule definitions	X
Sessions	Retrieve all sessions	X
	Retrieve one session	X
	Delete a session		X
	Update session timeout		X
Snapshots	Get a paginated list of all snapshot definitions	X
	Create snapshot		X
	Get a snapshot definition	X
	Delete a snapshot		X
	Restore the state of the domain objects to this snapshot		X
	Compare two snapshot definitions	X
Steps	Get a paginated list of all step definitions	X
	Create a step definition		X
	Get a single-step definition	X
	Update a step definition		X
	Delete a step		X
	Invoke (run) a step		X
	Get a single-step definition versions	X
	Compare two-step definitions	X
Sync credentials	Sync credentials		X
Variables	Get a paginated list of all variable definitions	X
	Create a variable definition		X
	Get a single variable definition	X
	Update a variable definition		X
	Delete a variable		X
	Get a single variable definition versions	X
	Compare two variable definitions	X
XDBC	Execute command		X
	Get cursor	X
	Prepare and execute		X
	Prepare command		X
	Get prepared	X
	Delete prepared		X
	Execute prepared		X
	Get cursor data	X
	Delete cursor		X
	Download file	X