/api/v2/AftermarketServices/Certificates

No Documentation Found.

/api/v2/AftermarketServices/ECUs/{serialNumber}

Activate or Deactivate an ECU, or Report an ECU as Damaged.

• serialNumber (path, required) — The serial number of the ECU.
• EDTInstanceId (query, required) — The EDT Instance Id of the kit calling this method.

/api/v2/AftermarketServices/Engines/{serialNumber}/IQACodes

Get injector codes given engine.

• serialNumber (path, required) — The serial number of the engine.
• EDTInstanceId (query, required) — The EDT Instance Id of the kit calling this method.

/api/v2/AftermarketServices/Engines/{serialNumber}/IQACodes

Report the IQA codes used by an engine

• serialNumber (path, required) — The serial number of the Engine
• EDTInstanceId (query, required) — The EDT Instance Id of the kit calling this method.

/api/v2/AftermarketServices/Engines/{serialNumber}/ProductionData

Get production calibration data for given engine.

• serialNumber (path, required) — The serial number of the engine.
• EDTInstanceId (query, required) — The EDT Instance Id of the kit calling this method.

/api/v2/AftermarketServices/Hello

Check whether there is connectivity to AGCO Power Web Services

/api/v2/AftermarketServices/UserStatuses

Retrieve the status of an EDT Kit Registration with AGCO Power Web Services

• voucherCode (query, required)
• dealerCode (query, required)

/api/v2/AftermarketServices/UserStatuses

Update the status of an EDT Kit Registration with AGCO Power Web Services

/api/v2/AuthenticatedUsers/{UserID}/Tokens

Manage API tokens.

• UserID (path, required)

/api/v2/Authentication

Authenticate a user.

/api/v2/Authentication/IsAlive

Acknowledges the connection to the API

/api/v2/Authentication/RequestPasswordReset

Request a password reset.

/api/v2/Authentication/ResetPasword

Reset a password

/api/v2/AuthorizationCategories

Get authorization categories.

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• userID (query) — Optional. Filter by categories visible to the provided user with the provided userID.
• definitionID (query) — Optional. Filter by categories containing a definition with the provided ID.

/api/v2/AuthorizationCategories

Add an authorization category.

/api/v2/AuthorizationCategories/Users

Returns a report of access that users have to Authorization Categories.

• limit (query, limit) — Optional. Defaults to 10.
• offset (query, offset) — Optional. Defaults to 0.
• userIDs (query) — Optional. Includes only users with IDs on the provided comma-separated list.
• categoryIDs (query) — Optional. Includes only users with categories with IDs on the provided comma-separated list.
• includeCategories (query) — If true, include full Authorization Category detail. Defaults to false.
• includeUsers (query) — If true, include full User detail. Defaults to false.
• userSearch (query) — Optional. Includes only users with a Name, Username, or Email containing the provided value.

/api/v2/AuthorizationCategories/{id}

Remove an authorization category.

• id (path, required) — The ID of the authorization category.

/api/v2/AuthorizationCategories/{id}

Update an authorization category.

• id (path, required)

/api/v2/AuthorizationCategories/{id}/Users/{userID}

Deletes a category a user could see.

• id (path, required)
• userID (path, required)

/api/v2/AuthorizationCategories/{id}/Users/{userID}

Add a category that a user can see.

• id (path, required)
• userID (path, required)

/api/v2/AuthorizationCodeDefinitions

Get authorization code definitions.

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• name (query) — Optional. If specified, filters definitions by name. Starting and ending wildcards (*) supported.
• createdByUserID (query) — Optional. If specified, filters definitions to those created by the given User ID.
• deletedByUserID (query) — Optional. If specified, filters definitions to those deleted by the given User ID.
• includeDeleted (query) — Optional. Whether to include deleted definitions. 'False' by default.
• categoryID (query) — Optional. If specified, filters definitions with the designated categoryID.

/api/v2/AuthorizationCodeDefinitions

Add an authorization code definition.

/api/v2/AuthorizationCodeDefinitions/{ID}/Categories/{categoryID}

Deletes the category from the authorization code definition.

• ID (path, required)
• categoryID (path, required) — A category ID, as a GUID.

/api/v2/AuthorizationCodeDefinitions/{ID}/Categories/{categoryID}

Add a category to an authorizationCodeDefintion.

• ID (path, required)
• categoryID (path, required) — A category ID, as a GUID.

/api/v2/AuthorizationCodeDefinitions/{id}

Disable an authorization code definition

• id (path, required) — The ID of the authorization code definition.

/api/v2/AuthorizationCodeDefinitions/{id}

Get an authorization code definition by its ID

• id (path, required) — The ID of the authorization code definition.

/api/v2/AuthorizationCodeDefinitions/{id}

Update an authorization code definition

• id (path, required) — The ID of the authorization code definition.

/api/v2/AuthorizationCodes

Get authorization codes.

• code (query) — Optional. If provided, searches for entities with the provided authorization code.
• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• definitionID (query) — Optional. If specified, filters codes by definition id.
• createdByUserID (query) — Optional. If specified, filters codes to those created by the given User ID.
• deletedByUserID (query) — Optional. If specified, filters codes to those deleted by the given User ID.
• includeDeleted (query) — Optional. Whether to include deleted codes. 'False' by default.

/api/v2/AuthorizationCodes

Generates an authorization code using the provided definition and parameters.

/api/v2/AuthorizationCodes/{id}

Hide an authorization code.

• id (path, required) — The id of the authorization code.

/api/v2/AuthorizationCodes/{id}

Get an authorization code by its ID.

• id (path, required) — The id of the authorization code.

/api/v2/AuthorizationCodes/{id}

Update an authorization code.

• id (path, required) — The id of the authorization code.

/api/v2/AuthorizationCodes/{id}/ContactInformation

Get contact information for an authorization code.

• id (path, required) — The id of the authorization code.

/api/v2/AuthorizationCodes/{id}/Validate

No Documentation Found.

• id (path, required)

/api/v2/AuthorizationContactInformation

Get contact information for authorization codes.

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• authorizationCode (query) — Optional. Search by authorization code.
• afterDate (query) — Optional. Include only data for authorization codes created after a provided date.
• beforeDate (query) — Optional. Include only data for authorization codes created before a provided date.
• dealerCode (query) — Optional. Search by dealer code.

/api/v2/AuthorizationContactInformation

Add contact information for authorization code.

/api/v2/Brands

Gets a list of Brands.

/api/v2/ContentDefinitions/{contentDefinitionID}

Delete a ContentDefinition

• contentDefinitionID (path, required) — The ID of the ContentDefinition to delete

/api/v2/Bundles

Get the list of bundles.

• UpdateGroupID (query) — Optional. Filter by UpdateGroup ID.
• Active (query) — Optional. Filter by active status.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.
• BundleNumber (query) — Optional. If provided, filters by BundleNumber.

/api/v2/Bundles

Add a Bundle to the Update System.

/api/v2/Bundles/{ID}

Delete a Bundle.

• ID (path, required) — The Bundle ID to Delete

/api/v2/Bundles/{ID}

Get a specific Bundle by ID.

• ID (path, required) — The Bundle ID

/api/v2/Bundles/{ID}

Modify a Bundle in the Update System.

• ID (path, required) — The unique ID of the Bundle

/api/v2/Clients

Get a List of Clients in the Update System.

• Tag (query) — Optional. Filter clients by Tag. Wildcards are supported (*).
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Clients/{ClientID}/CachedFiles

Get a list of Cached Files installed on the client Machine.

• ClientID (path, required) — The ClientID of the Client
• Expired (query, required) — Only Expired Files (true|false)

/api/v2/Clients/{ClientID}/PackageReports

Get the package reports for a client.

• ClientID (path, required) — The Client ID

/api/v2/Clients/{ClientID}/PackageReports

Submit a package report

• ClientID (path, required) — The Client ID

/api/v2/Clients/{ClientID}/PackageReports/Batch

Submit a batch of package reports

• ClientID (path, required) — The Client ID

/api/v2/Clients/{ID}

Get a Client in the Update System.

• ID (path, required) — The Client ID

/api/v2/Clients/{ID}

Update a Client.

• ID (path, required) — The Client ID

/api/v2/Clients/{ID}/AvailableUpdateGroupSubscriptions

Get a Client's Available Update Group Subscriptions

• ID (path, required) — The Client ID
• UpdateGroupID (query) — Optional. Filter by Update Group.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Clients/{ID}/UpdateGroupSubscriptions

Get a Client's Current Update Group Subscriptions

• ID (path, required) — The Client ID
• UpdateGroupID (query) — Optional. Filter by Update Group.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/ContentDefinitionAttributes/Batch

No Documentation Found.

/api/v2/ContentDefinitionAttributes/{contentDefinitionAttributeID}

Remove an Attribute from a ContentDefinition

• contentDefinitionAttributeID (path, required) — The ID of the Attribute to remove.

/api/v2/ContentDefinitionAttributes/{contentDefinitionAttributeID}

Update an Attribute for a ContentDefinition

• contentDefinitionAttributeID (path, required) — The ID of the Attribute to update.

/api/v2/ContentDefinitions

Get ContentDefinitions

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• userID (query) — Optional. Filter by UserID.
• includeAttributes (query) — Names of Attributes to include when retrieving this definition. This should be a comma-separated list. If not provided, Attributes are not included. If '*', all Attributes are included.
• name (query) — Optional. Filter by Name. Supports beginning and ending wildcard (*).
• typeID (query) — Optional. Filter by TypeID.
• packageTypeID (query) — Optional. Filter by PackageTypeID.

/api/v2/ContentDefinitions

Create a ContentDefinition

/api/v2/ContentDefinitions/{contentDefinitionID}

Get a ContentDefinition by ID

• contentDefinitionID (path, required) — The ID of the ContentDefinition to get.
• includeAttributes (query) — Names of Attributes to include when retrieving this definition. This should be a comma-separated list. If not provided, Attributes are not included. If '*', all Attributes are included.

/api/v2/ContentDefinitions/{contentDefinitionID}

Update a ContentDefinition

• contentDefinitionID (path, required) — The ID of the ContentDefinition to update

/api/v2/ContentDefinitions/{contentDefinitionID}/Attributes

Get Attributes for a ContentDefinition

• contentDefinitionID (path, required) — The ID of the ContentDefinition.
• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• name (query) — Optional. Filter the attributes by Name.

/api/v2/ContentDefinitions/{contentDefinitionID}/Attributes

Add an Attribute to a ContentDefinition

• contentDefinitionID (path, required) — The ID of the ContentDefinition

/api/v2/ContentDefinitions/{contentDefinitionID}/Attributes/Batch

No Documentation Found.

• contentDefinitionID (path, required)

/api/v2/ContentReleases

Get ContentReleaseVersion

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• deleted (query) — Optional. Filter by deleted.
• releaseID (query) — Optional. Filter by releaseID.
• userId (query) — Optional. Filter by UserID.
• contentDefinitionID (query) — Optional. Filter by ContentDefinitionID.
• version (query) — Optional. Filter by Version.

/api/v2/ContentReleases

Create a ContentReleaseVersion

/api/v2/ContentReleases/{ContentReleaseId}

Delete a ContentReleaseVersion

• ContentReleaseId (path, required) — The ID of the ContentReleaseVersion to delete

/api/v2/ContentReleases/{ContentReleaseId}

Get a Content Release Version by ID

• ContentReleaseId (path, required) — The ID of the ContentReleaseVersion to get.

/api/v2/ContentReleases/{ContentReleaseId}

Update a ContentReleaseVersion

• ContentReleaseId (path, required) — The ID of the ContentReleaseVersion to update

/api/v2/ContentSubmissionAttributes/Batch

No Documentation Found.

/api/v2/ContentSubmissionAttributes/{contentSubmissionAttributeID}

Remove an Attribute from a ContentSubmission

• contentSubmissionAttributeID (path, required) — The ID of the Attribute to remove.

/api/v2/ContentSubmissionAttributes/{contentSubmissionAttributeID}

Update an Attribute for a ContentSubmission

• contentSubmissionAttributeID (path, required) — The ID of the Attribute to update.

/api/v2/ContentSubmissionTypes

Returns available Content Submission Types.

• enabled (query)

/api/v2/ContentSubmissionTypes

Add a Content Submission Type

/api/v2/ContentSubmissionTypes/{id}

Remove a Content Submission Type

• id (path, required) — The ID of the Content Submission Type

/api/v2/ContentSubmissionTypes/{id}

Retrieves a Content Submission Type by its ID.

• id (path, required) — The ID of the Content Submission Type

/api/v2/ContentSubmissionTypes/{id}

Update a Content Submission Type

• id (path, required) — The ID of the Content Submission Type

/api/v2/Files/{ID}

Update the metadata for a file. Size may not be modified by the client.

• ID (path, required) — The file's id

/api/v2/Files/{ID}/FileContents

Download the contents of a file. The current State of the File should be 'Available'.

• ID (path, required) — The file's metadata.

/api/v2/Files/{ID}/FileContents

Upload the contents of a file. The current State of the File should be 'Created'.

• ID (path, required) — The file's metadata.

/api/v2/Licenses/{ID}

Get a license.

• ID (path, required) — The ID of the license to get.

/api/v2/ContentSubmissions

Get ContentSubmissions

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• userID (query) — Optional. Filter by UserID.
• contentDefinitionID (query) — Optional. Filter by ContentDefinitionID
• includeAttributes (query) — Names of Attributes to include when retrieving this submission. This should be a comma-separated list. If not provided, Attributes are not included. If '*', all Attributes are included.
• releaseID (query) — Optional. Filter the submissions by whether they are part of the Release with the specified Release ID.
• typeID (query) — Optional. Filter submissions by their ContentDefinition's Type ID.
• version (query) — Optional. Filter submissions by their Version.
• includeDefinition (query) — Optional. If true, includes the ContentDefinition for each submission.

/api/v2/ContentSubmissions

Create a ContentSubmission

/api/v2/ContentSubmissions/{contentSubmissionID}

Delete a ContentSubmission

• contentSubmissionID (path, required) — The ID of the ContentSubmission to delete

/api/v2/ContentSubmissions/{contentSubmissionID}

Get a ContentSubmission by ID

• contentSubmissionID (path, required) — The ID of the ContentSubmission to get.
• includeAttributes (query) — Names of Attributes to include when retrieving this submission. This should be a comma-separated list.

/api/v2/ContentSubmissions/{contentSubmissionID}

Update a ContentSubmission

• contentSubmissionID (path, required) — The ID of the ContentSubmission to update

/api/v2/ContentSubmissions/{contentSubmissionID}/Attributes

Get Attributes for a ContentSubmission

• contentSubmissionID (path, required) — The ID of the ContentSubmission.
• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• name (query) — Optional. Filter the attributes by Name.

/api/v2/ContentSubmissions/{contentSubmissionID}/Attributes

Add an Attribute to a ContentSubmission

• contentSubmissionID (path, required) — The ID of the ContentSubmission

/api/v2/ContentSubmissions/{contentSubmissionID}/Attributes/Batch

No Documentation Found.

• contentSubmissionID (path, required)

/api/v2/ContentSubmissions/{contentSubmissionID}/Status

Get the status of a ContentSubmission

• contentSubmissionID (path, required) — The ID of the ContentSubmission to get.
• includeActivityRunDetails (query) — True to include all status details if JobRun. Defaults to false

/api/v2/DealerByCountry

Get a total count of dealers per country

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Dealers

Get a list of dealers.

• Brand (query) — The brand to filter by.
• ShippingCountry (query) — The country to filter by.
• DealerName (query) — The partial Dealer Name to filter by. Wildcard supported (*).
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Dealers/{DealerCode}

Lookup a dealer using a dealer code.

• DealerCode (path, required) — The Dealer Code to Search for

/api/v2/Files

Get a paged response of file metadata.

• includeDeleted (query) — Indicates whether to include files marked as removed.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Files

Create the metadata for a file before uploading. The State of the File should be 'Created'.

/api/v2/Files/{ID}

Mark a file as 'Removed'. Disables download of the file and hides metadata from GET all method

• ID (path, required) — The file's id.

/api/v2/Files/{ID}

Gets a file's metadata.

• ID (path, required)

/api/v2/GlobalImageCategories

Get a paged response of file metadata.

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/GlobalImageCategories

Create the metadata for a file before uploading. The State should be 'Created'.

/api/v2/GlobalImageCategories/{ID}

Gets a file's metadata.

• ID (path, required) — The file's id.

/api/v2/GlobalImages

Get a paged response of GlobalImage.

• search (query) — Optional. Searches for matching global images with the matching Category Name, Publisher or Description
• categoryId (query)
• publisher (query)
• includeDeleted (query) — Indicates whether to include GlobalImages marked as removed.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/GlobalImages

Create the metadata for a GlobalImage before uploading. The State should be 'Created'.

• overridePublisherOrDate (query) — Whether to set the publisher and date to the provided values.

/api/v2/GlobalImages/{ID}

Mark a file as 'Removed'. Disables download of the image and hides metadata from GET all method

• ID (path, required) — The GlobalImage's id.

/api/v2/GlobalImages/{ID}

Gets a GlobalImage's metadata.

• ID (path, required) — The GlobalImage's id.

/api/v2/GlobalImages/{ID}

Update the metadata for an image.

• ID (path, required) — The GlobalImage's id.
• overridePublisherOrDate (query) — Whether to set the publisher and date to the provided values.

/api/v2/GlobalImages/{ID}/ImageContents

Download the contents of a GlobalImage. The current State of the GlobalImage should be 'Available'.

• ID (path, required) — The global image metadata id.
• isFullImage (query) — Indicated whether to download the full image or the thumbnail. Defaults to 'true'.

/api/v2/GlobalImages/{ID}/ImageContents

Upload the contents of a GlobalImage. The current State of the File for the GlobalImage should be 'Created'.

• ID (path, required) — The global image metadata id.
• isFullImage (query) — Indicated whether this is the full image or the thumbnail. Defaults to 'true'.

/api/v2/Languages

Get a list of the languages for which translations are supported. Returns a PagedResponse of Language objects.

• limit (query, limit) — limit the number of Language objects returned. Optional (defaults to 10).
• offset (query, offset) — the number of Language objects to skip. Optional (defaults to 0).
• includeDeleted (query) — whether to include languages marked as deleted. Defaults to false

/api/v2/Languages

Add a Language to support for translations. Accepts a Language object. Returns the Id of the created object.

/api/v2/Languages/{LocaleID}

Remove a Language from those supported for translations. Marks language as deleted.

• LocaleID (path, required)

/api/v2/Languages/{LocaleID}

Get a language by its id. Returns a Language object

• LocaleID (path, required)

/api/v2/Languages/{LocaleID}

Update a language’s description. Accepts a Language object.

• LocaleID (path, required)

/api/v2/LicenseActivations

Create a license activation.

/api/v2/LicenseActivations/RegisterEDTLite

Register an EDT Lite with the Server

/api/v2/LicenseActivations/{ID}

Update a license activiation.

• ID (path, required) — The ID of the license.

/api/v2/LicenseActivations/{ID}/Confirm

Confirm that the client has applied the updated license.

• ID (path, required) — The ID of the license

/api/v2/Licenses

Gets a list of licenses with the specified criteria.

• VoucherCode (query) — Optional. Filter by VoucherCode
• DealerCode (query) — Optional. Filter by DealerCode
• Status (query) — Optional. Filter by Status. By default only active licenses will be returned.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Logs

Get the API System logs, most recent first.

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Logs

Add a Log entry

• Message (query, required) — Message to enter into the log

/api/v2/Logs/{ID}

Get a log by ID

• ID (path, required) — The Log ID

/api/v2/Notifications

Sends an email message.

/api/v2/PackageTypes

Get all of the Package Types.

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.
• userID (query) — Optional. The user ID to sort packageTypes by the user's access

/api/v2/PackageTypes

Add a Package Type.

/api/v2/PackageTypes/{ID}

Delete a Package Type.

• ID (path, required) — The Package Type ID

/api/v2/PackageTypes/{ID}

Get a specific Package Type.

• ID (path, required) — The Package Type ID

/api/v2/PackageTypes/{ID}

Modify a Package Type.

• ID (path, required) — The ID of the Package Type

/api/v2/PackageTypes/{id}/Users/{userID}

Deletes a package type a user could see.

• id (path, required) — The ID of the Package Type
• userID (path, required) — The userID to link to the package type

/api/v2/PackageTypes/{id}/Users/{userID}

Add a package type that a user can see.

• id (path, required) — The ID of the Package Type
• userID (path, required) — The userID to link to the package type

/api/v2/PackageTypetoBundles

Delete a Package Type to Bundle Relationship.

• BundleID (query, required) — The BundleID
• PackageTypeID (query, required) — The PackageTypeID

/api/v2/PackageTypetoBundles

Get all of the Package Type to Bundle Relationships.

• BundleID (query) — Optional. Filter by BundleID.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/PackageTypetoBundles

Add a new Package Type ID to Bundle Relationship.

/api/v2/PackageTypetoBundles

Update a Package Type ID to Bundle Relationship.

/api/v2/Packages

List Packages.

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.
• PackageTypeID (query) — Optional. If provided, filters by PackageTypeID.
• Version (query) — Optional. If provided, filters by Version.
• Released (query) — Optional. If provided, filters by Released.

/api/v2/Packages

Add a Package to the Update System.

/api/v2/Packages/{ID}

Delete a Package.

• ID (path, required) — The Package ID to Delete

/api/v2/Packages/{ID}

Find a Package.

• ID (path, required) — The Package ID to Search for

/api/v2/Packages/{ID}

Modify a Packge to the Update System.

• ID (path, required) — The unique ID of the Package

/api/v2/Permissions

List Permissions

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.
• name (query) — Filter by permission name. Supports ending wildcard (*). Optional.

/api/v2/Permissions

Adds a Permission

/api/v2/Permissions/{id}

Deletes a Permission

• id (path, required) — Id of Permission

/api/v2/Permissions/{id}

Gets a Permission

• id (path, required) — Id of Permission

/api/v2/Permissions/{id}

Updates a Permission

• id (path, required) — Id of Permission

/api/v2/PriorityPackages

Get a list of Priority Packages by Client.

• ClientID (query) — Optional. Filter priority packages by ClientID.
• Status (query) — Optional. Filter returned packages by status. By default only active packages will be returned.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/PriorityPackages

Add a Priority Package for a Client.

/api/v2/PriorityPackages/{ID}

Delete a Priority Package for a Client.

• ID (path, required) — The Priority Package ID

/api/v2/PriorityPackages/{ID}

Get a Priority Packages for a Client.

• ID (path, required) — The Priority Package ID

/api/v2/Releases

Get Release

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• visible (query) — Optional. Filter by visible.
• bundleID (query) — Optional. Filter by BundleID.

/api/v2/Releases

Create a Release

/api/v2/Releases/{ReleaseId}

Get a Release by ID

• ReleaseId (path, required) — The ID of the Release to get.

/api/v2/Releases/{ReleaseId}/Bundle/{BundleId}

Deletes the association between a release and a bundle.

• ReleaseId (path, required) — The release identifier.
• BundleId (path, required) — The bundle identifier.

/api/v2/Releases/{ReleaseId}/Bundle/{BundleId}

Associates the release with a bundle.

• ReleaseId (path, required) — The release identifier.
• BundleId (path, required) — The bundle identifier.

/api/v2/Releases/{releaseId}

Update a Release

• releaseId (path, required) — The ID of the Release to update

/api/v2/Reporting/BundleStatusSummary

Get a summary of all Packages in a Bundle

• BundleID (query, required) — The BundleID
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Reporting/BundlesInUpdateGroup

Get a list of bundles for UpdateGroup.

• ID (query, required) — The UpdateGroupID
• IncludeInactive (query, required) — Include Inactive Bundles (true|false)
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Reporting/ClientInfo

Get Client Information

• ClientID (query, required) — The Client ID

/api/v2/Reporting/CurrentPackagesInUpdateGroup

Get the current packages for an update group.

• ID (query, required) — The UpdateGroupID
• SubscriptionTypeFilter (query) — Optional. The subscription type filter to use. By default the Default packages (Required and IncludeByDefault) will be returned.

/api/v2/Reporting/GetClient

Get a Client in the Update System.

• ID (query, required) — The Client ID

/api/v2/Reporting/GetSubscriptions

Get a list of current Client Subscriptions.

• ClientID (query) — Optional. Filter by Client ID
• UpdateGroupID (query) — Optional. Filter by Update Group ID
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Reporting/PackageStatusSummary

Get a summary report for a Specific Package

• PackageID (query, required) — The Package ID

/api/v2/TranslationSets/{ID}

Update a Translation Set. Accepts a TranslationSet object. Only the state property may be updated.

• ID (path, required)

/api/v2/TranslationSets/{ID}/Attributes

Create a TranslationSetAttribute object

• ID (path, required)

/api/v2/Reporting/RegisteredClients

Get a list of subscribed clients

• UpdateGroupID (query) — Optional but required when including any or all of following parameters: ReportValue, ReportResult, ReportResultIsValid. The Update Group ID. If not provided, all clients will be returned.
• ClientID (query) — Optional. Filter where ClientID matches a value. Wildcards are supported (*).
• Tag (query) — Optional. Filter where Tag matches a value. Wildcards are supported (*).
• ReportResult (query) — Optional and UpdateGroupID must be included. Filter where ReportResult matches a value. Wildcards are supported (*).
• ReportResultIsValid (query) — Optional and UpdateGroupID must be included. When 'true' filters results where ReportResult equals ReportResultExpected. When 'false' filters results where ValueToValidate does not equal ReportResults.
• ReportValue (query) — Optional and UpdateGroupID must be included. Filter where ReportValue matches a value. Wildcards are supported (*).
• LastCheckInBefore (query) — Optional. Filter where LastCheckIn occured before the provided date.
• LastCheckInAfter (query) — Optional. Filter where LastCheckIn occured after the provided date.
• OrderBy (query) — Optional. Specify the order in which results should be returned. Use this format: [FieldName] [ASC|ASCENDING|DESC|DESCENDING],... If sort direction is not provided for a field, it will be sorted ascending.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Reporting/UpdateGroups

Get a list of Update Groups. Update Groups are used by the client to register for a specific type of update.

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Reporting/UpdateMetrics

Get data for pie charts in UpdateMetrics.

• UpdateGroupID (query, required) — The UpdateType in which clients must be for the report to include them.
• bundleNumber (query) — Optional. Tells us which chart to show based upon filter.

/api/v2/Roles

List Roles

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.
• name (query) — Optional. Finds a role with the given name.
• permissionID (query)
• permissionName (query) — Optional. Filters roles by whether they contain the provided permission.

/api/v2/Roles

Adds a User Role

/api/v2/Roles/{id}

Deletes a User Role

• id (path, required) — The role's id

/api/v2/Roles/{id}

Gets a User Role

• id (path, required) — The role's id

/api/v2/Roles/{id}

Updates a User Role

• id (path, required) — The role's id

/api/v2/Roles/{id}/Permissions

Get the Permissions for a Role

• id (path, required) — The id of the Role
• name (query) — Filter by permission name. Optional.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Roles/{id}/Permissions

Manage the Permissions for a Role

• id (path, required) — The id of the Role

/api/v2/Roles/{id}/Users

Get all user's in a role

• id (path, required) — The Role's ID
• limit (query, limit) — The page limit. The default page limit is 10.
• offset (query, offset) — The page offset. The default page offset is 0.

/api/v2/Roles/{id}/Users

Update a Role's users

• id (path, required) — The Role's ID

/api/v2/StringDefinitions

Get a paged response of Global String Definitions.

• limit (query, limit) — Optional. The page limit. The default page limit is 10. Ignored if 'stringIds' is provided.
• modifiedAfterTimestamp (query) — Optional. Return only the StringDefinition objects that have a Timestamp value greater than that provided. This will be an encoded byte array.
• includeTranslations (query) — Optional. Indicates whether to include the StringTranslations for the StringDefinition. Defaults to false.
• stringText (query) — Optional. The text for which to search in the StringDefinition object’s translations. Only StringDefinition objects for matching StringTranslation objects are returned. Does not filter if no value is provided. Supports beginning and/or ending wildcards. includeTranslations must be true.
• descriptionText (query) — Optional. The text for which to search in the StringDefinition description field. Only matching objects are returned. Does not filter if no value is provided. Supports beginning and/or ending wildcards.
• useFullText (query) — Optional. This flag is used to determin whether to use the FullText Search or not.
• includeDeletedLanguages (query) — Optional. Indicates whether to include languages marked as deleted. includeTranslations must be true. Defaults to false.
• languageIds (query) — Optional. A comma-delimited list of language ids. Only StringTranslation objects with a matching language id will be returned. Optional. By default all locales are returned. includeTranslations must be true. The StringDefinition is still returned even if the filtered translations list is empty.
• stringIds (query) — Optional. A comma-delimited list of string ids. Up to 40 string IDs may be provided. May not be used with 'modifiedAfterTimestamp', 'stringText', 'descriptionText', or 'useFullText'.
• matchingTranslationsOnly (query) — Optional. If false, all translations for returned String Definitions are included. Must be used with 'stringText' provided and 'includeTranslations' = true.

/api/v2/StringDefinitions/Batch

Create StringDefinition object. The originating translation must be provided. Accepts an array of StringDefinition objects. Returns nothing.

/api/v2/StringDefinitions/Batch

Update StringDefinition objects. Accepts an array of StringDefinition objects. This endpoint will add StringDefinitionChange objects to the database. The DescriptionForTranslator may not be modified after a String is submitted for translation.

/api/v2/TranslationSets/{ID}/Attributes

Get a PagedResponse of TranslationSetAttribute objects

• ID (path, required)
• limit (query, limit)
• offset (query, offset)
• name (query)

/api/v2/StringDefinitions/{ID}

Get a paged response of Global String Definitions.

• ID (path, required)
• includeTranslations (query) — Optional. Indicates whether to include the StringTranslations for the StringDefinition. Defaults to false.
• includeDeletedLanguages (query) — Optional. Indicates whether to include languages marked as deleted. includeTranslations must be true. Defaults to false.
• languageIds (query) — Optional. A comma-delimited list of language ids. Only StringTranslation objects with a matching language id will be returned. Optional. By default all locales are returned. includeTranslations must be true. The StringDefinition is still returned even if the filtered translations list is empty.

/api/v2/StringTranslations

Get a paged response of Global String Translations.

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• modifiedAfterTimestamp (query) — Optional. Return only the StringDefinition objects that have a Timestamp value greater than that provided. This will be an encoded byte array.

/api/v2/StringTranslations/Batch

Update corrections to string translations

/api/v2/StringTranslations/{stringId}/{languageId}

Get a single translation based upon stringId and languageId

• stringId (path, required)
• languageId (path, required)

/api/v2/StringTranslations/{stringId}/{languageId}

Update a string value or a state for a string translation.

• stringId (path, required)
• languageId (path, required)

/api/v2/TranslationKeys

Get a paged response of TranslationKeys.

• limit (query, limit)
• offset (query, offset)
• keyNames (query) — Can filter by keyNames, a comma deliminated list.

/api/v2/TranslationKeys

Create a translationKey object.

/api/v2/TranslationKeys/{ID}

Get TranslationKey by ID

• ID (path, required)

/api/v2/TranslationKeys/{ID}

Update the StringID of the translationKey object.

• ID (path, required)

/api/v2/TranslationRequests

Get all TranslationRequest objects. Returns a PagedResponse of TranslationRequest objects with their language ids and string ids.

• limit (query, limit)
• offset (query, offset)

/api/v2/TranslationRequests

Create a translation request. Accepts a TranslationRequest object. Returns the Id of the created object. The state of the TranslationRequest must be ‘NotSubmitted’.

/api/v2/TranslationRequests/{Id}

Get a TranslationRequest object by id. Returns TranslationRequest object with its language ids and string ids.

• Id (path, required)

/api/v2/TranslationRequests/{Id}

Update a TranslationRequest object by id. Accepts a TranslationRequest object.

• Id (path, required)
• doResendRequest (query)

/api/v2/TranslationRequests/{Id}/Strings

No Documentation Found.

• Id (path, required)

/api/v2/TranslationSetAttributes/Batch

No Documentation Found.

/api/v2/TranslationSetAttributes/{ID}

Delete a set of TranslationSetAttribute object

• ID (path, required)

/api/v2/TranslationSetAttributes/{ID}

Update a TranslationSetAttribute object

• ID (path, required)

/api/v2/TranslationSets

Get a PagedResponse of TranslationSet objects. Related TranslationSetStrings are NOT returned

• limit (query, limit)
• offset (query, offset)
• translationRequestID (query)
• state (query)
• stringId (query)
• languageId (query)
• includeAttributes (query) — Names of Attributes to include when retrieving this submission. This should be a comma-separated list. If not provided, Attributes are not included. If '*', all Attributes are included.

/api/v2/TranslationSets/{ID}

Get a TranslationSet object by its id. Related TranslationSetStrings are NOT returned.

• ID (path, required)
• includeAttributes (query) — Names of Attributes to include when retrieving this Translation set. This should be a comma-separated list. If not provided, Attributes are not included. If '*', all Attributes are included.

/api/v2/TranslationSets/{ID}/Attributes/Batch

No Documentation Found.

• ID (path, required)

/api/v2/TranslationSets/{ID}/SourceStrings

Gets the information needed to translate a string in a translation set

• ID (path, required)
• limit (query, limit)
• offset (query, offset)

/api/v2/TranslationSets/{ID}/Statistics

Gets the statistics for translation sets such as the language ids and count of string definitions.

• ID (path, required)

/api/v2/TranslationSets/{ID}/Strings

Get a PagedResponse of TranslationSetString objects

• ID (path, required)
• limit (query, limit)
• offset (query, offset)

/api/v2/TranslationSets/{ID}/Strings

No Documentation Found.

• ID (path, required)

/api/v2/UpdateGroupClientRelationships

Get a list of current Client Subscriptions.

• ClientID (query) — Optional. Filter by Client ID
• UpdateGroupID (query) — Optional. Filter by Update Group ID
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.
• Active (query) — Optional. Filter by Active

/api/v2/UpdateGroupClientRelationships

Add a subscription

/api/v2/UpdateGroupClientRelationships

DEPRECATED. Set client subscription status for an update group.

• ClientID (query, required) — The Client ID. This can be a client ID that has not been registered yet.
• UpdateGroupID (query, required) — The Update Group ID
• Active (query, required) — Subscribe the client to the Update Group.

/api/v2/UpdateGroupClientRelationships/{RelationshipID}

Get a subscription by RelationshipID

• RelationshipID (path, required) — The RelationshipID.

/api/v2/UpdateGroupClientRelationships/{RelationshipID}

Updates a Subscription

• RelationshipID (path, required) — The relationship id of the UpdateGroupClientRelationship

/api/v2/UpdateGroupSubscriptions

Get Update Group Subscriptions

• UpdateGroupID (query) — Optional. Filter by Update Group ID.
• PackageTypeID (query) — Optional. Filter by Package Type ID.
• ClientID (query) — Optional. Filter by Client ID.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/UpdateGroupSubscriptions

Add an Update Group Subscription

/api/v2/UpdateGroupSubscriptions/Batch

No Documentation Found.

/api/v2/UpdateGroupSubscriptions/Batch

No Documentation Found.

/api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}

Delete an Update Group Subscription

• UpdateGroupSubscriptionID (path, required) — The Update Group Subscription ID to delete

/api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}

Get an Update Group Subscription

• UpdateGroupSubscriptionID (path, required) — The Update Group Subscription ID

/api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}

Update an Update Group Subscription

• UpdateGroupSubscriptionID (path, required) — The Update Group Subscription ID

/api/v2/UpdateGroups

Get a list of Update Groups. Update Groups are used by the client to register for a specific type of update.

• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.
• userID (query) — Optional. The user ID to sort update groups by the user's access

/api/v2/UpdateGroups

Add a new Update Group. The report field is a string that has a dot based request for a specific piece of submitted data.

/api/v2/UpdateGroups/{ID}

Delete an Update Group.

• ID (path, required) — The ID of the Update Group to Delete

/api/v2/UpdateGroups/{ID}

Get a specific Update Group by ID.

• ID (path, required) — The ID of the Update Group

/api/v2/UpdateGroups/{ID}

Modify an Update Group.

• ID (path, required) — ID of the Update Group

/api/v2/UpdateGroups/{ID}/Bundles

Get a list of bundles for UpdateGroup.

• ID (path, required) — The UpdateGroupID
• IncludeInactive (query, required) — Include Inactive Bundles (true|false)
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/UpdateGroups/{id}/Users/{userID}

Deletes an update group a user could see.

• id (path, required) — The ID of the update group
• userID (path, required) — The userID to link to the update group

/api/v2/UpdateGroups/{id}/Users/{userID}

Add an updateGroup that a user can see.

• id (path, required) — The ID of the update group
• userID (path, required) — The userID to link to the update group

/api/v2/UpdateSystem

Checks the Client ID into the Update System.

• ClientID (query, required) — The Client ID to check-in. If this is a new client ID it will be added to Clients.
• Preview (query, required) — Get Pkgs w\o updating Datetimes(true|false)
• RunAllInventories (query) — Force return inventories. Defaults to false.

/api/v2/UserContentDefinitions

Get UserContentDefinitions

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• userID (query) — Optional. Filter by UserID.
• contentDefinitionID (query) — Optional. Filter by ContentDefinitionID

/api/v2/UserContentDefinitions

Create a UserContentDefinition

/api/v2/UserContentDefinitions/{userContentDefinitionID}

Delete a UserContentDefinition

• userContentDefinitionID (path, required) — The ID of the UserContentDefinition to delete

/api/v2/UserContentDefinitions/{userContentDefinitionID}

Get a UserContentDefinition by ID

• userContentDefinitionID (path, required) — The ID of the UserContentDefinition to get.

/api/v2/Users

Get users

• username (query) — Optional. Search by username. Supports beginning and ending wildcards (*).
• email (query) — Optional. Search by email. Supports beginning and ending wildcards (*).
• name (query) — Optional. Search by name. Supports beginning and ending wildcards (*).
• hasRole (query) — Optional. Return only users having the provided role name.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Users

Create a user

/api/v2/Users/Current

Gets the current user

/api/v2/Users/Current

Update a user

/api/v2/Users/Current/Permissions

Get a user's permissions

• Permission (query) — Filter by permission name. Supports ending wildcard (*). Optional.
• limit (query, limit) — The page limit. The default page limit is 10.
• offset (query, offset) — The page offset. The default page offset is 0.

/api/v2/Users/Current/Roles

Gets the current user's roles

• Role (query) — Filter by role name. Supports ending wildcard (*). Optional.
• limit (query, limit) — The page limit. The default page limit is 10.
• offset (query, offset) — The page offset. The default page offset is 0.

/api/v2/Users/{id}

Delete a user

• id (path, required) — The user id

/api/v2/Users/{id}

Get a specific user

• id (path, required) — The user ID

/api/v2/Users/{id}

Update a user

• id (path, required) — The user id

/api/v2/Users/{id}/Permissions

Get a user's permissions

• id (path, required) — The User's ID
• Permission (query) — Filter by permission name. Supports ending wildcard (*). Optional.
• limit (query, limit) — The page limit. The default page limit is 10.
• offset (query, offset) — The page offset. The default page offset is 0.

/api/v2/Users/{id}/Roles

Get a user's roles

• id (path, required) — The User's ID
• Role (query) — Filter by role name. Supports ending wildcard (*). Optional.
• limit (query, limit) — The page limit. The default page limit is 10.
• offset (query, offset) — The page offset. The default page offset is 0.

/api/v2/Users/{id}/Roles

Update a user's roles

• id (path, required) — The User's ID

/api/v2/VoucherHistory

Gets voucher history data

• VoucherCode (query) — Optional. Filter history data by Voucher Code.
• ChangedBefore (query) — Optional. Filter history data where changes occured before provided date.
• ChangedAfter (query) — Optional. Filter history data where changes occured after provided date.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Vouchers

Gets a list of vouchers

• Type (query) — Optional. Filter vouchers by Type
• DealerCode (query) — Optional. Filter vouchers by DealerCode
• LicenseTo (query) — Optional. Filter vouchers by LicenseTo. Wildcard supported (*).
• Purpose (query) — Optional. Filter vouchers by Purpose. Wildcard supported (*).
• OrderNumber (query) — Optional. Filter vouchers by OrderNumber
• Email (query) — Optional. Filter vouchers by Email. Wildcard supported (*).
• ModifiedBy (query) — Optional. Filter vouchers by ModifiedBy
• CreatedAfter (query) — Optional. Filter vouchers by CreatedDate
• CreatedBefore (query) — Optional. Filter vouchers by CreatedDate
• PunchedAfter (query) — Optional. Filter vouchers by PunchedDate
• PunchedBefore (query) — Optional. Filter vouchers by PunchedDate
• Punched (query) — Optional. Filter vouchers by Punched status
• ExpirationAfter (query) — Optional. Filter vouchers by ExpirationDate
• ExpirationBefore (query) — Optional. Filter vouchers by ExpirationDate
• Deleted (query) — Optional. Filter vouchers by Deleted state. By default only vouchers that are not deleted are returned.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/Vouchers

Create a voucher

/api/v2/Vouchers/{VoucherCode}

Delete a voucher

• VoucherCode (path, required) — The voucher code of the voucher to delete.

/api/v2/Vouchers/{VoucherCode}

Get a voucher

• VoucherCode (path, required) — The voucher code of the voucher to get.
• Deleted (query) — Optional. Filter vouchers by Deleted state. By default only vouchers that are not deleted are returned.

/api/v2/Vouchers/{VoucherCode}

Update a voucher

• VoucherCode (path, required) — The voucher code of the voucher to update.

/api/v2/Vouchers/{VoucherCode}/VoucherHistory

Get a voucher's history.

• VoucherCode (path, required) — The voucher code to get history for.
• limit (query, limit) — Optional. The page limit. The default page limit is 10.
• offset (query, offset) — Optional. The page offset. The default page offset is 0.

/api/v2/activities

Get Activities

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• isIncludeDeleted (query) — Does it include deleted activity, or not

/api/v2/activities

Create an Activity

/api/v2/activities/{activityID}

Mark the delete flag for the Activity

• activityID (path, required) — The id of the activity to delete

/api/v2/activities/{activityID}

Get an Activity by ID

• activityID (path, required) — The ID of the Activity to get.
• isIncludeDeleted (query) — Does it include deleted activity, or not

/api/v2/activities/{activityID}

Update an Activity

• activityID (path, required) — The id of the activity to update

/api/v2/activityRuns

Get ActivityRuns

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• status (query) — Optional. Filter activity runs by status. Value should be a comma separated list of status to include. If not specified, the default status filter is “InProgress”.

/api/v2/activityRuns/{activityRunID}

Get an ActivityRun by ID

• activityRunID (path, required) — The ID of the ActivityRun to get.

/api/v2/activityRuns/{activityRunID}

Update an ActivityRun

• activityRunID (path, required) — The ID of the ActivityRun to update ActivityRunStatus for.

/api/v2/activityRuns/{activityRunID}/status

Get the ActivityRunStatus of an ActivityRun

• activityRunID (path, required) — The ID of the ActivityRun to get ActivityRunStatus for.

/api/v2/activityRuns/{activityRunID}/status

Update the ActivityRunStatus of an ActivityRun

• activityRunID (path, required) — The ID of the ActivityRun to update ActivityRunStatus for.

/api/v2/agents

Get Agents

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.

/api/v2/agents

Create an Agent

/api/v2/agents/Current

Get Agent associated with the current user

/api/v2/agents/Current/ActivityRun

Get the ActivityRun of Agent associated with the current user

/api/v2/agents/{agentID}

Delete an Agent

• agentID (path, required) — The id of the Agent to delete.

/api/v2/agents/{agentID}

Get Agent

• agentID (path, required) — The id of the Agent to get.

/api/v2/agents/{agentID}

Update an Agent

• agentID (path, required) — The id of the Agent to update.

/api/v2/agents/{agentID}/ActivityRun

Get an Agent's ActivityRun

• agentID (path, required) — The id of the Agent to get.

/api/v2/agents/{agentID}/ActivityRun

Update the ActivityRun assigned to the Agent.

• agentID (path, required) — The id of the Agent to update.

/api/v2/agents/{agentID}/Status

Update an Agent

• agentID (path, required) — The id of the Agent to update.

/api/v2/jobRuns

Get JobRuns

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• includeActivityRunDetails (query) — Optional. Indicates whether to include ActivityRun details. Defaults to false.

/api/v2/jobRuns

Create a JobRun

/api/v2/jobRuns/{jobRunID}

Delete a JobRun

• jobRunID (path, required) — The id of the JobRun to delete

/api/v2/jobRuns/{jobRunID}

Get a JobRun by ID

• jobRunID (path, required) — The ID of the JobRun to get.
• includeActivityRunDetails (query) — Optional. Indicates whether to include ActivityRun details. Defaults to false.

/api/v2/jobRuns/{jobRunID}

Update a JobRun

• jobRunID (path, required) — The id of the JobRun to update

/api/v2/jobs

Get Jobs

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• isIncludeDeleted (query) — Does it include deleted job, or not

/api/v2/jobs

Create a Job

/api/v2/jobs/{jobID}

Mark the delete flag for the Job

• jobID (path, required) — The id of the job to delete

/api/v2/jobs/{jobID}

Get a Job by ID

• jobID (path, required) — The ID of the Job to get.
• isIncludeDeleted (query) — Does it include deleted job, or not

/api/v2/jobs/{jobID}

Update a Job

• jobID (path, required) — The id of the job to update

/api/v2/steps

Get Steps

• limit (query, limit) — Optional. The page limit. If not specified, the default page limit is 10.
• offset (query, offset) — Optional. The page offset. If not specified, the default page offset is 0.
• includeDeleted (query) — Does it include deleted step, or not

/api/v2/steps

Create a Step

/api/v2/steps/{stepID}

Get a Step by ID

• stepID (path, required) — The ID of the Step to get.
• isIncludeDeleted (query) — Does it include deleted step, or not

/api/v2/steps/{stepID}

Update a Step

• stepID (path, required) — The step ID of the step to update