API

API version: v1

Auth

ApiKey code in query

Base URL

https://secure.agco-ats.com

Setup

1. Set your API key in the appropriate header
2. GET /api/v2/activities -- verify access
3. POST /api/v2/activities -- create first activities

Endpoints

286 endpoints across 1 groups. See references/api-spec.lap for full details.

api

Method	Path	Description
GET	/api/v2/activities	Get Activities
POST	/api/v2/activities	Create an Activity
GET	/api/v2/activities/{activityID}	Get an Activity by ID
PUT	/api/v2/activities/{activityID}	Update an Activity
DELETE	/api/v2/activities/{activityID}	Mark the delete flag for the Activity
GET	/api/v2/activityRuns	Get ActivityRuns
GET	/api/v2/activityRuns/{activityRunID}	Get an ActivityRun by ID
PUT	/api/v2/activityRuns/{activityRunID}	Update an ActivityRun
GET	/api/v2/activityRuns/{activityRunID}/status	Get the ActivityRunStatus of an ActivityRun
PUT	/api/v2/activityRuns/{activityRunID}/status	Update the ActivityRunStatus of an ActivityRun
GET	/api/v2/AftermarketServices/Certificates	No Documentation Found.
PUT	/api/v2/AftermarketServices/ECUs/{serialNumber}	Activate or Deactivate an ECU, or Report an ECU as Damaged.
GET	/api/v2/AftermarketServices/Engines/{serialNumber}/ProductionData	Get production calibration data for given engine.
GET	/api/v2/AftermarketServices/Engines/{serialNumber}/IQACodes	Get injector codes given engine.
PUT	/api/v2/AftermarketServices/Engines/{serialNumber}/IQACodes	Report the IQA codes used by an engine
GET	/api/v2/AftermarketServices/UserStatuses	Retrieve the status of an EDT Kit Registration with AGCO Power Web Services
PUT	/api/v2/AftermarketServices/UserStatuses	Update the status of an EDT Kit Registration with AGCO Power Web Services
GET	/api/v2/AftermarketServices/Hello	Check whether there is connectivity to AGCO Power Web Services
GET	/api/v2/agents	Get Agents
POST	/api/v2/agents	Create an Agent
GET	/api/v2/agents/{agentID}	Get Agent
PUT	/api/v2/agents/{agentID}	Update an Agent
DELETE	/api/v2/agents/{agentID}	Delete an Agent
GET	/api/v2/agents/Current	Get Agent associated with the current user
GET	/api/v2/agents/{agentID}/ActivityRun	Get an Agent's ActivityRun
PUT	/api/v2/agents/{agentID}/ActivityRun	Update the ActivityRun assigned to the Agent.
GET	/api/v2/agents/Current/ActivityRun	Get the ActivityRun of Agent associated with the current user
PUT	/api/v2/agents/{agentID}/Status	Update an Agent
PUT	/api/v2/AuthenticatedUsers/{UserID}/Tokens	Manage API tokens.
POST	/api/v2/Authentication	Authenticate a user.
GET	/api/v2/Authentication/IsAlive	Acknowledges the connection to the API
POST	/api/v2/Authentication/RequestPasswordReset	Request a password reset.
POST	/api/v2/Authentication/ResetPasword	Reset a password
GET	/api/v2/Authentication/OAuthRedirect	Redirect to OIDC provider with configured and provided query parameters.
GET	/api/v2/Authentication/OAuthCallback	Provided as "redirectUri" query parameter when redirecting to OIDC provider.
POST	/api/v2/Authentication/OAuthUser	Login using OpenID.
GET	/api/v2/Authentication/OAuthCertificate	Retrieve the certificate used for OAuth Client Authentication.
GET	/api/v2/AuthorizationCategories	Get authorization categories.
POST	/api/v2/AuthorizationCategories	Add an authorization category.
PUT	/api/v2/AuthorizationCategories/{id}	Update an authorization category.
DELETE	/api/v2/AuthorizationCategories/{id}	Remove an authorization category.
POST	/api/v2/AuthorizationCategories/{id}/Users/{userID}	Add a category that a user can see.
DELETE	/api/v2/AuthorizationCategories/{id}/Users/{userID}	Deletes a category a user could see.
GET	/api/v2/AuthorizationCategories/Users	Returns a report of access that users have to Authorization Categories.
GET	/api/v2/AuthorizationCodeDefinitions	Get authorization code definitions.
POST	/api/v2/AuthorizationCodeDefinitions	Add an authorization code definition.
GET	/api/v2/AuthorizationCodeDefinitions/{id}	Get an authorization code definition by its ID
PUT	/api/v2/AuthorizationCodeDefinitions/{id}	Update an authorization code definition
DELETE	/api/v2/AuthorizationCodeDefinitions/{id}	Disable an authorization code definition
POST	/api/v2/AuthorizationCodeDefinitions/{ID}/Categories/{categoryID}	Add a category to an authorizationCodeDefintion.
DELETE	/api/v2/AuthorizationCodeDefinitions/{ID}/Categories/{categoryID}	Deletes the category from the authorization code definition.
GET	/api/v2/AuthorizationCodes	Get authorization codes.
POST	/api/v2/AuthorizationCodes	Generates an authorization code using the provided definition and parameters.
GET	/api/v2/AuthorizationCodes/{id}	Get an authorization code by its ID.
PUT	/api/v2/AuthorizationCodes/{id}	Update an authorization code.
DELETE	/api/v2/AuthorizationCodes/{id}	Hide an authorization code.
GET	/api/v2/AuthorizationCodes/{id}/Validate	No Documentation Found.
GET	/api/v2/AuthorizationCodes/{id}/ContactInformation	Get contact information for an authorization code.
GET	/api/v2/AuthorizationContactInformation	Get contact information for authorization codes.
POST	/api/v2/AuthorizationContactInformation	Add contact information for authorization code.
GET	/api/v2/Brands	Gets a list of Brands.
GET	/api/v2/Bundles	Get the list of bundles.
POST	/api/v2/Bundles	Add a Bundle to the Update System.
GET	/api/v2/Bundles/{ID}	Get a specific Bundle by ID.
PUT	/api/v2/Bundles/{ID}	Modify a Bundle in the Update System.
DELETE	/api/v2/Bundles/{ID}	Delete a Bundle.
GET	/api/v2/Clients	Get a List of Clients in the Update System.
GET	/api/v2/Clients/{ID}	Get a Client in the Update System.
PUT	/api/v2/Clients/{ID}	Update a Client.
GET	/api/v2/Clients/{ID}/UpdateGroupSubscriptions	Get a Client's Current Update Group Subscriptions
GET	/api/v2/Clients/{ID}/AvailableUpdateGroupSubscriptions	Get a Client's Available Update Group Subscriptions
GET	/api/v2/ContentDefinitions	Get ContentDefinitions
POST	/api/v2/ContentDefinitions	Create a ContentDefinition
GET	/api/v2/ContentDefinitions/{contentDefinitionID}	Get a ContentDefinition by ID
PUT	/api/v2/ContentDefinitions/{contentDefinitionID}	Update a ContentDefinition
DELETE	/api/v2/ContentDefinitions/{contentDefinitionID}	Delete a ContentDefinition
GET	/api/v2/ContentDefinitions/{contentDefinitionID}/Attributes	Get Attributes for a ContentDefinition
POST	/api/v2/ContentDefinitions/{contentDefinitionID}/Attributes	Add an Attribute to a ContentDefinition
POST	/api/v2/ContentDefinitions/{contentDefinitionID}/Attributes/Batch	No Documentation Found.
PUT	/api/v2/ContentDefinitionAttributes/{contentDefinitionAttributeID}	Update an Attribute for a ContentDefinition
DELETE	/api/v2/ContentDefinitionAttributes/{contentDefinitionAttributeID}	Remove an Attribute from a ContentDefinition
PUT	/api/v2/ContentDefinitionAttributes/Batch	No Documentation Found.
GET	/api/v2/ContentReleases	Get ContentReleaseVersion
POST	/api/v2/ContentReleases	Create a ContentReleaseVersion
GET	/api/v2/ContentReleases/{ContentReleaseId}	Get a Content Release Version by ID
PUT	/api/v2/ContentReleases/{ContentReleaseId}	Update a ContentReleaseVersion
DELETE	/api/v2/ContentReleases/{ContentReleaseId}	Delete a ContentReleaseVersion
GET	/api/v2/ContentSubmissions	Get ContentSubmissions
POST	/api/v2/ContentSubmissions	Create a ContentSubmission
GET	/api/v2/ContentSubmissions/{contentSubmissionID}	Get a ContentSubmission by ID
PUT	/api/v2/ContentSubmissions/{contentSubmissionID}	Update a ContentSubmission
DELETE	/api/v2/ContentSubmissions/{contentSubmissionID}	Delete a ContentSubmission
GET	/api/v2/ContentSubmissions/{contentSubmissionID}/Status	Get the status of a ContentSubmission
GET	/api/v2/ContentSubmissions/{contentSubmissionID}/Attributes	Get Attributes for a ContentSubmission
POST	/api/v2/ContentSubmissions/{contentSubmissionID}/Attributes	Add an Attribute to a ContentSubmission
POST	/api/v2/ContentSubmissions/{contentSubmissionID}/Attributes/Batch	No Documentation Found.
PUT	/api/v2/ContentSubmissionAttributes/{contentSubmissionAttributeID}	Update an Attribute for a ContentSubmission
DELETE	/api/v2/ContentSubmissionAttributes/{contentSubmissionAttributeID}	Remove an Attribute from a ContentSubmission
PUT	/api/v2/ContentSubmissionAttributes/Batch	No Documentation Found.
GET	/api/v2/ContentSubmissionTypes	Returns available Content Submission Types.
POST	/api/v2/ContentSubmissionTypes	Add a Content Submission Type
GET	/api/v2/ContentSubmissionTypes/{id}	Retrieves a Content Submission Type by its ID.
PUT	/api/v2/ContentSubmissionTypes/{id}	Update a Content Submission Type
DELETE	/api/v2/ContentSubmissionTypes/{id}	Remove a Content Submission Type
GET	/api/v2/DealerByCountry	Get a total count of dealers per country
GET	/api/v2/Dealers/{DealerCode}	Lookup a dealer using a dealer code.
GET	/api/v2/Dealers	Get a list of dealers.
GET	/api/v2/Files	Get a paged response of file metadata.
POST	/api/v2/Files	Create the metadata for a file before uploading. The State of the File should be 'Created'.
GET	/api/v2/Files/{ID}	Gets a file's metadata.
PUT	/api/v2/Files/{ID}	Update the metadata for a file. Size may not be modified by the client.
DELETE	/api/v2/Files/{ID}	Mark a file as 'Removed'. Disables download of the file and hides metadata from GET all method
GET	/api/v2/Files/{ID}/FileContents	Download the contents of a file. The current State of the File should be 'Available'.
PUT	/api/v2/Files/{ID}/FileContents	Upload the contents of a file. The current State of the File should be 'Created'.
GET	/api/v2/FileUploadIndexFields	Get File Upload Index Fields
POST	/api/v2/FileUploads/Report	Build a report from file uploads
GET	/api/v2/FileUploadTypes	Get File Upload Types
GET	/api/v2/GlobalImageCategories	Get a paged response of file metadata.
POST	/api/v2/GlobalImageCategories	Create the metadata for a file before uploading. The State should be 'Created'.
GET	/api/v2/GlobalImageCategories/{ID}	Gets a file's metadata.
GET	/api/v2/GlobalImages	Get a paged response of GlobalImage.
POST	/api/v2/GlobalImages	Create the metadata for a GlobalImage before uploading. The State should be 'Created'.
GET	/api/v2/GlobalImages/{ID}	Gets a GlobalImage's metadata.
PUT	/api/v2/GlobalImages/{ID}	Update the metadata for an image.
DELETE	/api/v2/GlobalImages/{ID}	Mark a file as 'Removed'. Disables download of the image and hides metadata from GET all method
GET	/api/v2/GlobalImages/{ID}/ImageContents	Download the contents of a GlobalImage. The current State of the GlobalImage should be 'Available'.
PUT	/api/v2/GlobalImages/{ID}/ImageContents	Upload the contents of a GlobalImage. The current State of the File for the GlobalImage should be 'Created'.
GET	/api/v2/jobRuns	Get JobRuns
POST	/api/v2/jobRuns	Create a JobRun
GET	/api/v2/jobRuns/{jobRunID}	Get a JobRun by ID
PUT	/api/v2/jobRuns/{jobRunID}	Update a JobRun
DELETE	/api/v2/jobRuns/{jobRunID}	Delete a JobRun
GET	/api/v2/jobs	Get Jobs
POST	/api/v2/jobs	Create a Job
GET	/api/v2/jobs/{jobID}	Get a Job by ID
PUT	/api/v2/jobs/{jobID}	Update a Job
DELETE	/api/v2/jobs/{jobID}	Mark the delete flag for the Job
GET	/api/v2/Languages	Get a list of the languages for which translations are supported. Returns a PagedResponse of Language objects.
POST	/api/v2/Languages	Add a Language to support for translations. Accepts a Language object. Returns the Id of the created object.
GET	/api/v2/Languages/{LocaleID}	Get a language by its id. Returns a Language object
PUT	/api/v2/Languages/{LocaleID}	Update a language’s description. Accepts a Language object.
DELETE	/api/v2/Languages/{LocaleID}	Remove a Language from those supported for translations. Marks language as deleted.
POST	/api/v2/LicenseActivations	Create a license activation.
PUT	/api/v2/LicenseActivations/{ID}	Update a license activiation.
PUT	/api/v2/LicenseActivations/{ID}/Confirm	Confirm that the client has applied the updated license.
POST	/api/v2/LicenseActivations/RegisterEDTLite	Register an EDT Lite with the Server
GET	/api/v2/Licenses	Gets a list of licenses with the specified criteria.
GET	/api/v2/Licenses/{ID}	Get a license.
GET	/api/v2/Logs	Get the API System logs, most recent first.
POST	/api/v2/Logs	Add a Log entry
GET	/api/v2/Logs/{ID}	Get a log by ID
POST	/api/v2/Notifications	Sends an email message.
PUT	/api/v2/Clients/{ClientID}/PackageReports/Batch	Submit a batch of package reports
GET	/api/v2/Clients/{ClientID}/PackageReports	Get the package reports for a client.
PUT	/api/v2/Clients/{ClientID}/PackageReports	Submit a package report
GET	/api/v2/Packages	List Packages.
POST	/api/v2/Packages	Add a Package to the Update System.
GET	/api/v2/Packages/{ID}	Find a Package.
PUT	/api/v2/Packages/{ID}	Modify a Packge to the Update System.
DELETE	/api/v2/Packages/{ID}	Delete a Package.
GET	/api/v2/PackageTypes	Get all of the Package Types.
POST	/api/v2/PackageTypes	Add a Package Type.
GET	/api/v2/PackageTypes/{ID}	Get a specific Package Type.
PUT	/api/v2/PackageTypes/{ID}	Modify a Package Type.
DELETE	/api/v2/PackageTypes/{ID}	Delete a Package Type.
POST	/api/v2/PackageTypes/{id}/Users/{userID}	Add a package type that a user can see.
DELETE	/api/v2/PackageTypes/{id}/Users/{userID}	Deletes a package type a user could see.
PUT	/api/v2/Bundles/{bundleID}/PackageTypetoBundles/Batch	Update multiple Package Type ID to Bundle Relationships.
POST	/api/v2/Bundles/{bundleID}/PackageTypetoBundles/Batch	No Documentation Found.
GET	/api/v2/PackageTypetoBundles	Get all of the Package Type to Bundle Relationships.
PUT	/api/v2/PackageTypetoBundles	Update a Package Type ID to Bundle Relationship.
POST	/api/v2/PackageTypetoBundles	Add a new Package Type ID to Bundle Relationship.
DELETE	/api/v2/PackageTypetoBundles	Delete a Package Type to Bundle Relationship.
GET	/api/v2/Permissions	List Permissions
POST	/api/v2/Permissions	Adds a Permission
GET	/api/v2/Permissions/{id}	Gets a Permission
PUT	/api/v2/Permissions/{id}	Updates a Permission
DELETE	/api/v2/Permissions/{id}	Deletes a Permission
GET	/api/v2/PriorityPackages	Get a list of Priority Packages by Client.
POST	/api/v2/PriorityPackages	Add a Priority Package for a Client.
GET	/api/v2/PriorityPackages/{ID}	Get a Priority Packages for a Client.
DELETE	/api/v2/PriorityPackages/{ID}	Delete a Priority Package for a Client.
GET	/api/v2/Releases	Get Release
POST	/api/v2/Releases	Create a Release
GET	/api/v2/Releases/{ReleaseId}	Get a Release by ID
PUT	/api/v2/Releases/{releaseId}	Update a Release
POST	/api/v2/Releases/{ReleaseId}/Bundle/{BundleId}	Associates the release with a bundle.
DELETE	/api/v2/Releases/{ReleaseId}/Bundle/{BundleId}	Deletes the association between a release and a bundle.
GET	/api/v2/Reporting/GetClient	Get a Client in the Update System.
GET	/api/v2/Reporting/ClientInfo	Get Client Information
GET	/api/v2/Reporting/GetSubscriptions	Get a list of current Client Subscriptions.
GET	/api/v2/Reporting/RegisteredClients	Get a list of subscribed clients
GET	/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.
GET	/api/v2/Reporting/PackageStatusSummary	Get a summary report for a Specific Package
GET	/api/v2/Reporting/BundleStatusSummary	Get a summary of all Packages in a Bundle
GET	/api/v2/Reporting/BundlesInUpdateGroup	Get a list of bundles for UpdateGroup.
GET	/api/v2/Reporting/CurrentPackagesInUpdateGroup	Get the current packages for an update group.
GET	/api/v2/Reporting/UpdateMetrics	Get data for pie charts in UpdateMetrics.
GET	/api/v2/Roles	List Roles
POST	/api/v2/Roles	Adds a User Role
GET	/api/v2/Roles/{id}	Gets a User Role
PUT	/api/v2/Roles/{id}	Updates a User Role
DELETE	/api/v2/Roles/{id}	Deletes a User Role
GET	/api/v2/Roles/{id}/Permissions	Get the Permissions for a Role
PUT	/api/v2/Roles/{id}/Permissions	Manage the Permissions for a Role
GET	/api/v2/steps	Get Steps
POST	/api/v2/steps	Create a Step
GET	/api/v2/steps/{stepID}	Get a Step by ID
PUT	/api/v2/steps/{stepID}	Update a Step
GET	/api/v2/StringDefinitions	Get a paged response of Global String Definitions.
GET	/api/v2/StringDefinitions/{ID}	Get a paged response of Global String Definitions.
PUT	/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.
POST	/api/v2/StringDefinitions/Batch	Create StringDefinition object. The originating translation must be provided. Accepts an array of StringDefinition objects. Returns nothing.
GET	/api/v2/StringTranslations	Get a paged response of Global String Translations.
GET	/api/v2/StringTranslations/{stringId}/{languageId}	Get a single translation based upon stringId and languageId
PUT	/api/v2/StringTranslations/{stringId}/{languageId}	Update a string value or a state for a string translation.
PUT	/api/v2/StringTranslations/Batch	Update corrections to string translations
GET	/api/v2/TranslationKeys	Get a paged response of TranslationKeys.
POST	/api/v2/TranslationKeys	Create a translationKey object.
GET	/api/v2/TranslationKeys/{ID}	Get TranslationKey by ID
PUT	/api/v2/TranslationKeys/{ID}	Update the StringID of the translationKey object.
GET	/api/v2/TranslationRequests	Get all TranslationRequest objects. Returns a PagedResponse of TranslationRequest objects with their language ids and string ids.
POST	/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’.
GET	/api/v2/TranslationRequests/{Id}	Get a TranslationRequest object by id. Returns TranslationRequest object with its language ids and string ids.
PUT	/api/v2/TranslationRequests/{Id}	Update a TranslationRequest object by id. Accepts a TranslationRequest object.
PUT	/api/v2/TranslationRequests/{Id}/Strings	No Documentation Found.
GET	/api/v2/TranslationSets	Get a PagedResponse of TranslationSet objects. Related TranslationSetStrings are NOT returned
GET	/api/v2/TranslationSets/{ID}	Get a TranslationSet object by its id. Related TranslationSetStrings are NOT returned.
PUT	/api/v2/TranslationSets/{ID}	Update a Translation Set. Accepts a TranslationSet object. Only the state property may be updated.
GET	/api/v2/TranslationSets/{ID}/Strings	Get a PagedResponse of TranslationSetString objects
PUT	/api/v2/TranslationSets/{ID}/Strings	No Documentation Found.
GET	/api/v2/TranslationSets/{ID}/SourceStrings	Gets the information needed to translate a string in a translation set
GET	/api/v2/TranslationSets/{ID}/Statistics	Gets the statistics for translation sets such as the language ids and count of string definitions.
GET	/api/v2/TranslationSets/{ID}/Attributes	Get a PagedResponse of TranslationSetAttribute objects
POST	/api/v2/TranslationSets/{ID}/Attributes	Create a TranslationSetAttribute object
PUT	/api/v2/TranslationSetAttributes/{ID}	Update a TranslationSetAttribute object
DELETE	/api/v2/TranslationSetAttributes/{ID}	Delete a set of TranslationSetAttribute object
PUT	/api/v2/TranslationSetAttributes/Batch	No Documentation Found.
POST	/api/v2/TranslationSets/{ID}/Attributes/Batch	No Documentation Found.
GET	/api/v2/UpdateGroupClientRelationships	Get a list of current Client Subscriptions.
PUT	/api/v2/UpdateGroupClientRelationships	DEPRECATED. Set client subscription status for an update group.
POST	/api/v2/UpdateGroupClientRelationships	Add a subscription
GET	/api/v2/UpdateGroupClientRelationships/{RelationshipID}	Get a subscription by RelationshipID
PUT	/api/v2/UpdateGroupClientRelationships/{RelationshipID}	Updates a Subscription
GET	/api/v2/UpdateGroups	Get a list of Update Groups. Update Groups are used by the client to register for a specific type of update.
POST	/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.
GET	/api/v2/UpdateGroups/{ID}	Get a specific Update Group by ID.
PUT	/api/v2/UpdateGroups/{ID}	Modify an Update Group.
DELETE	/api/v2/UpdateGroups/{ID}	Delete an Update Group.
GET	/api/v2/UpdateGroups/{ID}/Bundles	Get a list of bundles for UpdateGroup.
POST	/api/v2/UpdateGroups/{id}/Users/{userID}	Add an updateGroup that a user can see.
DELETE	/api/v2/UpdateGroups/{id}/Users/{userID}	Deletes an update group a user could see.
GET	/api/v2/UpdateGroupSubscriptions	Get Update Group Subscriptions
POST	/api/v2/UpdateGroupSubscriptions	Add an Update Group Subscription
GET	/api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}	Get an Update Group Subscription
PUT	/api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}	Update an Update Group Subscription
DELETE	/api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}	Delete an Update Group Subscription
PUT	/api/v2/UpdateGroupSubscriptions/Batch	No Documentation Found.
POST	/api/v2/UpdateGroupSubscriptions/Batch	No Documentation Found.
GET	/api/v2/UpdateSystem	Checks the Client ID into the Update System.
GET	/api/v2/Clients/{ClientID}/CachedFiles	Get a list of Cached Files installed on the client Machine.
GET	/api/v2/UserContentDefinitions	Get UserContentDefinitions
POST	/api/v2/UserContentDefinitions	Create a UserContentDefinition
GET	/api/v2/UserContentDefinitions/{userContentDefinitionID}	Get a UserContentDefinition by ID
DELETE	/api/v2/UserContentDefinitions/{userContentDefinitionID}	Delete a UserContentDefinition
GET	/api/v2/Users/{id}/Permissions	Get a user's permissions
GET	/api/v2/Users/Current/Permissions	Get a user's permissions
GET	/api/v2/Users/{id}/Roles	Get a user's roles
PUT	/api/v2/Users/{id}/Roles	Update a user's roles
GET	/api/v2/Roles/{id}/Users	Get all user's in a role
PUT	/api/v2/Roles/{id}/Users	Update a Role's users
GET	/api/v2/Users/Current/Roles	Gets the current user's roles
GET	/api/v2/Users	Get users
POST	/api/v2/Users	Create a user
GET	/api/v2/Users/{id}	Get a specific user
PUT	/api/v2/Users/{id}	Update a user
DELETE	/api/v2/Users/{id}	Delete a user
GET	/api/v2/Users/Current	Gets the current user
PUT	/api/v2/Users/Current	Update a user
GET	/api/v2/VoucherHistory	Gets voucher history data
GET	/api/v2/Vouchers	Gets a list of vouchers
POST	/api/v2/Vouchers	Create a voucher
GET	/api/v2/Vouchers/{VoucherCode}	Get a voucher
PUT	/api/v2/Vouchers/{VoucherCode}	Update a voucher
DELETE	/api/v2/Vouchers/{VoucherCode}	Delete a voucher
GET	/api/v2/Vouchers/{VoucherCode}/VoucherHistory	Get a voucher's history.

Enhanced Skill Content

Question Mapping

• "How do I authenticate with the API?" -> POST /api/v2/Authentication
• "Is the API server running?" -> GET /api/v2/Authentication/IsAlive
• "How do I reset a forgotten password?" -> POST /api/v2/Authentication/RequestPasswordReset
• "What users exist and how do I search by name or email?" -> GET /api/v2/Users
• "What permissions does a specific user have?" -> GET /api/v2/Users/{id}/Permissions
• "How do I assign roles to a user?" -> PUT /api/v2/Users/{id}/Roles
• "How do I create a voucher and check its history?" -> POST /api/v2/Vouchers then GET /api/v2/Vouchers/{VoucherCode}/VoucherHistory
• "What dealers are available in a specific country or brand?" -> GET /api/v2/Dealers
• "How do I upload a file and retrieve its contents?" -> POST /api/v2/Files then GET /api/v2/Files/{ID}/FileContents
• "How do I check the status of a content submission?" -> GET /api/v2/ContentSubmissions/{contentSubmissionID}/Status
• "What packages are available in an update group?" -> GET /api/v2/Reporting/CurrentPackagesInUpdateGroup
• "How do I subscribe a client to an update group?" -> POST /api/v2/UpdateGroupClientRelationships
• "How do I manage translations for a specific string?" -> GET /api/v2/StringTranslations/{stringId}/{languageId} and PUT /api/v2/StringTranslations/{stringId}/{languageId}
• "How do I activate a license?" -> POST /api/v2/LicenseActivations
• "What is the deployment status of a bundle across clients?" -> GET /api/v2/Reporting/BundleStatusSummary

Response Tips

• List endpoints (activities, users, packages, etc.): Paginated via limit and offset query params. Always check if more records exist by comparing result count to limit.
• Single resource GET (by ID): Returns the full object on 200. A 404 means the ID does not exist or was soft-deleted -- retry with isIncludeDeleted=true or includeDeleted=true where supported.
• Create (POST): Returns 200 with the created object (including server-assigned ID). Capture the ID from the response for subsequent operations.
• Update (PUT) and Delete (DELETE): Return 204 with no body. A successful call means the operation completed -- do not parse the response body.
• Batch endpoints (Attributes/Batch, StringDefinitions/Batch): Accept arrays and return 204. Failures may be partial -- if you get an error, retry individual items to isolate the problem.
• Reporting endpoints: May return nested objects with summary statistics. Fields like ReportResult and ReportValue on RegisteredClients are filter params, not guaranteed response fields.
• Authentication: POST /api/v2/Authentication returns a token/session object on 200. Store the API key for subsequent code query parameter auth.

Anomaly Flags

• 204 on a GET request: Should never happen outside /Authentication/IsAlive. If a data-fetching GET returns 204, the resource may have been deleted or the endpoint is misconfigured.
• Soft-deleted records hidden by default: Many list endpoints exclude deleted items unless includeDeleted=true or isIncludeDeleted=true is passed. Surface this when a known ID returns 404.
• Typo in endpoint path: ResetPasword (missing 's') is the actual path -- flag if a user tries ResetPassword and gets 404.
• Inconsistent casing in paths: Some resources use PascalCase (/Vouchers, /Bundles), others use camelCase (/jobRuns, /steps). Surface mismatches proactively when constructing URLs.
• Large offset values: No cursor-based pagination exists. Warn when offset exceeds several thousand -- performance may degrade.
• Batch operations silently succeeding: PUT Batch endpoints return 204 with no details. Recommend a follow-up GET to verify changes applied correctly.
• OAuth flow state mismatch: The OAuthCallback endpoint accepts an error parameter. Surface any OAuth errors immediately rather than silently proceeding.
• Missing required EDTInstanceId: Aftermarket ECU and Engine endpoints require this alongside serial number. Flag if omitted.

Playbook

1. Authenticate and Verify Access

1. POST /api/v2/Authentication with credentials map containing username and password
2. Store the returned API key/token
3. GET /api/v2/Authentication/IsAlive to confirm the session is active (expect 204)
4. GET /api/v2/Users/Current to verify identity and retrieve your user profile
5. GET /api/v2/Users/Current/Permissions to confirm your permission scope

2. Publish a Content Update to Clients

1. POST /api/v2/ContentDefinitions to create a content definition (capture the returned ID)
2. POST /api/v2/ContentDefinitions/{id}/Attributes/Batch to attach metadata attributes
3. POST /api/v2/ContentSubmissions with contentDefinitionID referencing the definition
4. GET /api/v2/ContentSubmissions/{id}/Status to monitor processing progress
5. POST /api/v2/ContentReleases to create a release version once submission is complete
6. Associate the release with packages and bundles as needed via POST /api/v2/Packages and PUT /api/v2/Bundles/{bundleID}/PackageTypetoBundles/Batch

3. Set Up a Client with Update Group Subscriptions

1. GET /api/v2/Clients to find the client by Tag, or GET /api/v2/Clients/{ID} if ID is known
2. GET /api/v2/UpdateGroups to list available update groups
3. POST /api/v2/UpdateGroupClientRelationships with ClientID, UpdateGroupID, and Active: true
4. GET /api/v2/Clients/{ID}/UpdateGroupSubscriptions to verify the subscription is active
5. GET /api/v2/UpdateSystem with ClientID and Preview=true to preview what updates the client would receive

4. Manage Vouchers and Licensing

1. POST /api/v2/Vouchers with voucher details (type, dealer code, expiration)
2. GET /api/v2/Vouchers/{VoucherCode} to retrieve the created voucher
3. POST /api/v2/LicenseActivations with licenseActivationCreate referencing the voucher
4. PUT /api/v2/LicenseActivations/{ID}/Confirm to finalize the activation
5. GET /api/v2/Vouchers/{VoucherCode}/VoucherHistory to audit all changes over time

5. Configure Roles, Permissions, and Authorization

1. GET /api/v2/Permissions to list all available permissions
2. POST /api/v2/Roles to create a new role
3. PUT /api/v2/Roles/{id}/Permissions with an array of permission changes to attach permissions to the role
4. PUT /api/v2/Users/{id}/Roles with role changes to assign the role to a user
5. GET /api/v2/Users/{id}/Permissions to verify the user now has the expected effective permissions

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP