Gets a specific Binder for the domain.

Returns a specific Binder for the domain identified by the provided ID.

Gets the content for a specific Binder.

Returns the content associated with the binder identified by the provided ID.

Gets all of the Catalog(s) for the Domain.

Returns a list of all catalogs for the domain.

Clean up (remove from Vantage) all folders which are marked as Transient and are empty.

Instructs Vantage to remove all folders from the Catalog which have been marked as Transient and which are empty. This call is a programmatic way of invoking the same cleanup functionality which is available in the VMC->Catalogs pane for cleaning up empty folders in the catalog.

Returns the catalog entry from the current Domain corresponding to the provided ID.

Returns the catalog entry from the current Domain which corresponds to the provided value of ID. NOTE: If the provided ID does not correspond to a Catalog which exists in the current Domain, a NULL entry shall be returned in the Catalog response.

Create a new category

Creates a category with the specified name. If a category with the provided name already exists, it is returned. Otherwise, a new category is created and returned.

Check if a category exists

Returns an indication of whether the Category with the provided name exists in this domain.

Returns all outputs (Media Nicknames, Attachments, and/or Labels) associated with the specified content entry.

Returns all outputs such as Media Nicknames, Attachments, and/or Labels associated with the specified content entry. Supports JSONP responses, and the callback function can be specified using the "callback" query parameter.

Get all categories in the domain

Gets the load for the Vantage domain based on the provided criteria.

Returns the load for the Vantage domain based on the specified criteria, such as CPU usage.

Returns an indication as to whether the SDK service has successfully attached to the domain database

Returns a string representation of the version of the current Vantage domain

Returns all of the folder entries which exist in either the catalog or the folder whose Identifier corresponds to the provided ID.

Returns all of the folder entries which exist in either the catalog or the folder whose identifier corresponds to the provided ID.

Obtain the specified Binder object associated with the provided NAME and located in the folder identified by ID.

Returns the first binder that exactly matches the specified name located in the folder identified by ID. NOTE: Since a catalog folder may contain binders with duplicate names, it is advised to give them unique names when registering. If a binder with the specified name does not exist in the specified folder, a NULL value shall be returned.

Gets all of the Binder(s) for a given Catalog or Folder.

Returns all of the Binders which exist within the Folder with the provided ID. This method does not traverse the entire Folder hierarchy to discover all Binders which may exist in all sub-Folders of the specified Folder. It shall only return the Binder entries which reside within the Folder with the specified ID.

Returns information about the job with the provided identifier.

Returns detailed information about the job with the provided identifier.

Return all actions associated with a specific job.

Returns a list of all actions associated with the job identified by the provided ID.

Returns the relevant error message associated with a job which has failed.

Returns the relevant error message for a job identified by the provided ID that has failed.

Returns a collection of jobs which were created as a result of being forwarded from the specified job.

This endpoint allows a client to receive information about new jobs which are created as a result of Forward actions being present in a workflow. The presence of a Forward action in a workflow implies that a new job is being created. This endpoint method provides the ability to track a new job that is created via a current job containing one or more Forward actions. This method allows a reference to those newly created jobs to be returned so that each new job may be tracked by the client.

Return specific metrics about a specified job.

Returns specific metrics such as total run time and total queue time for the job identified by the provided ID.

Return all outputs (Media Nicknames, Attachments, and/or Labels) associated with a specific job.

Returns all outputs such as Media Nicknames, Attachments, and/or Labels associated with the job identified by the provided ID.

Return the progress (percent complete) for the specified job.

Returns the progress (percent complete) for the job identified by the provided ID.

Remove a completed job with the specified identifier.

Removes a completed job (Completed Successfully, Failed, or a job that has been stopped by a user) with the specified identifier.

Restarts a job which had previously been stopped.

Only a job that is in the "Stopped By User" state may be restarted.

Stops the job identified by the provided identifier.

Stops an in-process job (i.e., not complete) identified by the provided identifier.

Return all machines that host services in the domain.

Returns all machines that host services in the Vantage domain.

Instruct all services on the specified machine to begin the preshutdown state.

Instructs all services on the specified machine to begin the preshutdown state. This is only applicable to machines of the Transient type. When this request is made, all online services on the machine with the specified identifier (assuming this is a Transient machine) shall enter a state where they shall no longer accept new work. The services shall complete all active and queued work. Once this has completed, the services shall shutdown. This call is asynchronous, and the invoking entity will have no indication that the services have completed this request other than to monitor the service, noting that the services will eventually no longer be available due to the shutdown.

Gets all online services present in this Vantage domain.

Returns all online services present in the Vantage domain. Only services that are online are returned. Services in maintenance mode or any other state are not included.

Returns information about services hosting a specific type of action.

Returns information about services that host a specific type of action identified by the provided action type.

Gets all online services in the domain which reside on the specified machine.

Returns all online services in the Vantage domain that reside on the specified machine. Only services that are in the Online state are returned. Services in maintenance mode or any other state are not included.

Gets the metric information associated with the specified service.

Returns the metric information for the service identified by the provided ID.

Request that the specified service enter the preshutdown state.

Requests that the specified service enter the preshutdown state. This is only applicable to services of the Transient type. When this request is made, the service shall enter a state where it shall no longer accept new work. The service shall complete all active and queued work. Once this has completed, the service shall shutdown. This call is asynchronous, and the invoking entity will have no indication that the service has completed this request other than to monitor the service, noting that the service will eventually no longer be available due to the shutdown.

Return information about Vantage Managed Stores.

Returns information about Vantage Managed Stores with an optional qualifier to include offline stores.

Return information about the specified Vantage Managed Store.

Returns information about the specified Vantage Managed Store identified by the provided ID.

Get all workflows

Retrieves all the workflows available in the Vantage domain.

Create a new XML representation of a workflow at the specified path.

Exports the workflow identified by the WorkflowIdentifier field to the location specified by BasePathForExport field. If successful, returns the complete path of the newly exported file. If the specified workflow does not exist, or if there is a problem accessing the specified location, the export shall fail and an empty string '' shall be returned. NOTE: If there is a collision of names in the folder specified in BasePathForExport then this method shall unique-ify the output name of the newly exported workflow and return the new unique name.

Import a previously exported workflow

Imports a workflow that was previously exported from a Vantage domain.

Import a workflow specified by a file path.

The input to this workflow MUST be a traditional workflow XML document that is either: - Generated by the http://localhost:8676/Rest/Workflows/ExportToPath API call. - Created as a result of exporting a workflow from the Workflow Designer.

Resynchronize the definition of a workflow using the path to a Vantage workflow.

Attempts to resynchronize the definition of a workflow using the path to a Vantage workflow, previously generated by the call to ExportToPath into this domain or via manually exporting a workflow from the Workflow Designer. This method will overwrite an existing workflow if the workflow represented by the Identifier of the input workflow already exists in the domain. If the existing workflow is active, the workflow shall be placed into an edit state and updated to allow the definitions which are present in the supplied workflow to overwrite the existing definitions. Any in-process actions shall not be manipulated and shall continue to run with the definitions of the actions which were present when the job was initially created. If there is no existing workflow which corresponds to the workflow specified as input, then the new workflow is added to the domain without any existing workflows being modified.

Get workflow by ID

Activate a workflow

Activates the workflow with the specified identifier.

Deactivate the specified workflow.

Deactivates the workflow identified by the provided ID.

Export a compressed representation of a workflow

Retrieves a compressed, proprietary representation of the workflow with the specified identifier.

Get inputs for a workflow

Retrieves the inputs that may be submitted to the workflow with the specified identifier.

Return all jobs for a specified workflow which match the specified filter criteria.

Renames the specified workflow to a new name.

Obtain a value representing a unique signature for a workflow.

The signature shall remain constant so long as the workflow is not modified (Actions added or removed or updated, new connections made, workflow renamed or moved). NOTE: Importing the same workflow multiple times will assign each new import a new unique identifier and consequently each copy of the workflow would have a distinct (and different) Signature.

Submit a job to a workflow

Submits a job to the workflow with the specified identifier. The request data should be obtained via the `/Workflows/{ID}/JobInputs` GET query.

Submit a Binder to a workflow

Submits a Binder that exists in the Catalog to the workflow identified by the provided ID. Use `/Workflows/{ID}/JobInputs` to obtain the Variables the target workflow expects.