{"note":"OpenAPI conversion -- returning structured metadata","name":"agco-ats-com","description":"API","version":"v1","base_url":"https://secure.agco-ats.com","endpoints":285,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api API\n@base https://secure.agco-ats.com\n@version v1\n@auth ApiKey code in query\n@endpoints 285\n@hint download_for_search\n@toc api(285)\n\n@endpoint GET /api/v2/activities\n@desc Get Activities\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., isIncludeDeleted: any # Does it include deleted activity, or not}\n@returns(200) OK\n\n@endpoint POST /api/v2/activities\n@desc Create an Activity\n@required {activity: map # The activity to create.  The ActivityID will be assigned on creation of the Activity.}\n@returns(200) OK\n\n@endpoint GET /api/v2/activities/{activityID}\n@desc Get an Activity by ID\n@required {activityID: any # The ID of the Activity to get.}\n@optional {isIncludeDeleted: any # Does it include deleted activity, or not}\n@returns(200) OK\n\n@endpoint PUT /api/v2/activities/{activityID}\n@desc Update an Activity\n@required {activityID: any # The id of the activity to update, activity: map # The updated activity}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/activities/{activityID}\n@desc Mark the delete flag for the Activity\n@required {activityID: any # The id of the activity to delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/activityRuns\n@desc Get ActivityRuns\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., status: any # Optional. Filter activity runs by status.  Value should be a comma separated list of status to include.\r             If not specified, the default status filter is “InProgress”.}\n@returns(200) OK\n\n@endpoint GET /api/v2/activityRuns/{activityRunID}\n@desc Get an ActivityRun by ID\n@required {activityRunID: any # The ID of the ActivityRun to get.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/activityRuns/{activityRunID}\n@desc Update an ActivityRun\n@required {activityRunID: any # The ID of the ActivityRun to update ActivityRunStatus for., activityRun: map # The updated ActivityRun.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/activityRuns/{activityRunID}/status\n@desc Get the ActivityRunStatus of an ActivityRun\n@required {activityRunID: any # The ID of the ActivityRun to get ActivityRunStatus for.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/activityRuns/{activityRunID}/status\n@desc Update the ActivityRunStatus of an ActivityRun\n@required {activityRunID: any # The ID of the ActivityRun to update ActivityRunStatus for., activityRunStatus: map # The updated ActivityRunStatus.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/AftermarketServices/Certificates\n@desc No Documentation Found.\n@returns(200) OK\n\n@endpoint PUT /api/v2/AftermarketServices/ECUs/{serialNumber}\n@desc Activate or Deactivate an ECU, or Report an ECU as Damaged.\n@required {serialNumber: any # The serial number of the ECU., ECU: map # The ecu to modify., EDTInstanceId: any # The EDT Instance Id of the kit calling this method.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AftermarketServices/Engines/{serialNumber}/ProductionData\n@desc Get production calibration data for given engine.\n@required {serialNumber: any # The serial number of the engine., EDTInstanceId: any # The EDT Instance Id of the kit calling this method.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AftermarketServices/Engines/{serialNumber}/IQACodes\n@desc Get injector codes given engine.\n@required {serialNumber: any # The serial number of the engine., EDTInstanceId: any # The EDT Instance Id of the kit calling this method.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/AftermarketServices/Engines/{serialNumber}/IQACodes\n@desc Report the IQA codes used by an engine\n@required {serialNumber: any # The serial number of the Engine, IQACodes: [str] # A string array of IQA codes in physical order, EDTInstanceId: any # The EDT Instance Id of the kit calling this method.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AftermarketServices/UserStatuses\n@desc Retrieve the status of an EDT Kit Registration with AGCO Power Web Services\n@required {voucherCode: any, dealerCode: any}\n@returns(200) OK\n\n@endpoint PUT /api/v2/AftermarketServices/UserStatuses\n@desc Update the status of an EDT Kit Registration with AGCO Power Web Services\n@required {userStatus: map}\n@returns(200) OK\n\n@endpoint GET /api/v2/AftermarketServices/Hello\n@desc Check whether there is connectivity to AGCO Power Web Services\n@returns(200) OK\n\n@endpoint GET /api/v2/agents\n@desc Get Agents\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/agents\n@desc Create an Agent\n@required {agent: map # The Agent to create.  The AgentID will be assigned on creation of the Agent.}\n@returns(200) OK\n\n@endpoint GET /api/v2/agents/{agentID}\n@desc Get Agent\n@required {agentID: any # The id of the Agent to get.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/agents/{agentID}\n@desc Update an Agent\n@required {agentID: any # The id of the Agent to update., agent: map # The updated Agent}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/agents/{agentID}\n@desc Delete an Agent\n@required {agentID: any # The id of the Agent to delete.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/agents/Current\n@desc Get Agent associated with the current user\n@returns(200) OK\n\n@endpoint GET /api/v2/agents/{agentID}/ActivityRun\n@desc Get an Agent's ActivityRun\n@required {agentID: any # The id of the Agent to get.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/agents/{agentID}/ActivityRun\n@desc Update the ActivityRun assigned to the Agent.\n@required {agentID: any # The id of the Agent to update., activityRun: map # The ActivityRun assigned to the agent.  Only the ActivityRunID is used.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/agents/Current/ActivityRun\n@desc Get the ActivityRun of Agent associated with the current user\n@returns(200) OK\n\n@endpoint PUT /api/v2/agents/{agentID}/Status\n@desc Update an Agent\n@required {agentID: any # The id of the Agent to update., agentStatus: map # The updated AgentStatus.}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/AuthenticatedUsers/{UserID}/Tokens\n@desc Manage API tokens.\n@required {UserID: any, tokenOptions: map # The options for token management.}\n@returns(204) No Content\n\n@endpoint POST /api/v2/Authentication\n@desc Authenticate a user.\n@required {credentials: map # Create a user account.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Authentication/IsAlive\n@desc Acknowledges the connection to the API\n@returns(204) No Content\n\n@endpoint POST /api/v2/Authentication/RequestPasswordReset\n@desc Request a password reset.\n@required {passwordResetRequest: map # The password reset request.}\n@returns(204) No Content\n\n@endpoint POST /api/v2/Authentication/ResetPasword\n@desc Reset a password\n@required {passwordReset: map # The password reset detail.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Authentication/OAuthRedirect\n@desc Redirect to OIDC provider with configured and provided query parameters.\n@required {redirectUri: any # URI of target application to which to redirect once logged in to OIDC.}\n@optional {code_challenge: any # Value used PKCE to prevent abuse of authorization code., code_challenge_method: any # Used for PKCE. Method used to compute code_challenge from code_verifier. Supported values: 'S256'., response_mode: any # Optional. Location in redirect uri to place the authorization code. Supported values: 'fragment' and code'., prompt: any # Optional. Supported values: 'none', 'consent', 'select_account', and 'login'.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Authentication/OAuthCallback\n@desc Provided as \"redirectUri\" query parameter when redirecting to OIDC provider.\n@optional {code: any # Authorization code to be exchanged for an access token., state: any # Copy of the state parameter sent to the OIDC provider., error: any # Conditionally provided by OIDC provider in case of error., error_description: any # Conditionally provided by OIDC provider in case of error.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Authentication/OAuthUser\n@desc Login using OpenID.\n@required {tokenParams: map # Either 'code'  or 'refresh_token' is required.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Authentication/OAuthCertificate\n@desc Retrieve the certificate used for OAuth Client Authentication.\n@optional {download: any # True to download as a .cer file. Returns certificate properties by default., auth_verifier: any # Internal use., auth_verifier_ms: any # Internal use.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AuthorizationCategories\n@desc Get authorization categories.\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., userID: any # Optional. Filter by categories visible to the provided user with the provided userID., definitionID: any # Optional. Filter by categories containing a definition with the provided ID.}\n@returns(200) OK\n\n@endpoint POST /api/v2/AuthorizationCategories\n@desc Add an authorization category.\n@required {category: map # An authorization category.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/AuthorizationCategories/{id}\n@desc Update an authorization category.\n@required {id: any, category: map # An authorization category.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/AuthorizationCategories/{id}\n@desc Remove an authorization category.\n@required {id: any # The ID of the authorization category.}\n@returns(204) No Content\n\n@endpoint POST /api/v2/AuthorizationCategories/{id}/Users/{userID}\n@desc Add a category that a user can see.\n@required {id: any, userID: any}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/AuthorizationCategories/{id}/Users/{userID}\n@desc Deletes a category a user could see.\n@required {id: any, userID: any}\n@returns(204) No Content\n\n@endpoint GET /api/v2/AuthorizationCategories/Users\n@desc Returns a report of access that users have to Authorization Categories.\n@optional {limit: any # Optional. Defaults to 10., offset: any # Optional. Defaults to 0., userIDs: any # Optional. Includes only users with IDs on the provided comma-separated list., categoryIDs: any # Optional. Includes only users with categories with IDs on the provided comma-separated list., includeCategories: any # If true, include full Authorization Category detail. Defaults to false., includeUsers: any # If true, include full User detail. Defaults to false., userSearch: any # Optional. Includes only users with a Name, Username, or Email containing the provided value.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AuthorizationCodeDefinitions\n@desc Get authorization code definitions.\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., name: any # Optional. If specified, filters definitions by name. Starting and ending wildcards (*) supported., createdByUserID: any # Optional. If specified, filters definitions to those created by the given User ID., deletedByUserID: any # Optional. If specified, filters definitions to those deleted by the given User ID., includeDeleted: any # Optional. Whether to include deleted definitions. 'False' by default., categoryID: any # Optional. If specified, filters definitions with the designated categoryID.}\n@returns(200) OK\n\n@endpoint POST /api/v2/AuthorizationCodeDefinitions\n@desc Add an authorization code definition.\n@required {authorizationCodeDefinition: map # An authorization code definition.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AuthorizationCodeDefinitions/{id}\n@desc Get an authorization code definition by its ID\n@required {id: any # The ID of the authorization code definition.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/AuthorizationCodeDefinitions/{id}\n@desc Update an authorization code definition\n@required {id: any # The ID of the authorization code definition., authorizationCodeDefinition: map # An authorization code definition.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/AuthorizationCodeDefinitions/{id}\n@desc Disable an authorization code definition\n@required {id: any # The ID of the authorization code definition.}\n@returns(204) No Content\n\n@endpoint POST /api/v2/AuthorizationCodeDefinitions/{ID}/Categories/{categoryID}\n@desc Add a category to an authorizationCodeDefintion.\n@required {ID: any, categoryID: any # A category ID, as a GUID.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/AuthorizationCodeDefinitions/{ID}/Categories/{categoryID}\n@desc Deletes the category from the authorization code definition.\n@required {ID: any, categoryID: any # A category ID, as a GUID.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/AuthorizationCodes\n@desc Get authorization codes.\n@optional {code: any # Optional. If provided, searches for entities with the provided authorization code., limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., definitionID: any # Optional. If specified, filters codes by definition id., createdByUserID: any # Optional. If specified, filters codes to those created by the given User ID., deletedByUserID: any # Optional. If specified, filters codes to those deleted by the given User ID., includeDeleted: any # Optional. Whether to include deleted codes. 'False' by default.}\n@returns(200) OK\n\n@endpoint POST /api/v2/AuthorizationCodes\n@desc Generates an authorization code using the provided definition and parameters.\n@required {authorizationCode: map # The model from which to generate an authorization code.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AuthorizationCodes/{id}\n@desc Get an authorization code by its ID.\n@required {id: any # The id of the authorization code.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/AuthorizationCodes/{id}\n@desc Update an authorization code.\n@required {id: any # The id of the authorization code., authorizationCode: map # The model from which to update an authorization code.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/AuthorizationCodes/{id}\n@desc Hide an authorization code.\n@required {id: any # The id of the authorization code.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/AuthorizationCodes/{id}/Validate\n@desc No Documentation Found.\n@required {id: any}\n@returns(200) OK\n\n@endpoint GET /api/v2/AuthorizationCodes/{id}/ContactInformation\n@desc Get contact information for an authorization code.\n@required {id: any # The id of the authorization code.}\n@returns(200) OK\n\n@endpoint GET /api/v2/AuthorizationContactInformation\n@desc Get contact information for authorization codes.\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., authorizationCode: any # Optional. Search by authorization code., afterDate: any # Optional. Include only data for authorization codes created after a provided date., beforeDate: any # Optional. Include only data for authorization codes created before a provided date., dealerCode: any # Optional. Search by dealer code.}\n@returns(200) OK\n\n@endpoint POST /api/v2/AuthorizationContactInformation\n@desc Add contact information for authorization code.\n@required {contactInfo: map # A contact information.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Brands\n@desc Gets a list of Brands.\n@returns(200) OK\n\n@endpoint GET /api/v2/Bundles\n@desc Get the list of bundles.\n@optional {UpdateGroupID: any # Optional. Filter by UpdateGroup ID., Active: any # Optional. Filter by active status., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., BundleNumber: any # Optional. If provided, filters by BundleNumber.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Bundles\n@desc Add a Bundle to the Update System.\n@required {bundle: map # The bundle to add}\n@optional {cloneFromBundleID: any # Optional. A BundleID from which to clone PackageTypetoBundleIDs.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Bundles/{ID}\n@desc Get a specific Bundle by ID.\n@required {ID: any # The Bundle ID}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Bundles/{ID}\n@desc Modify a Bundle in the Update System.\n@required {ID: any # The unique ID of the Bundle, bundle: map # The bundle to modify}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Bundles/{ID}\n@desc Delete a Bundle.\n@required {ID: any # The Bundle ID to Delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Clients\n@desc Get a List of Clients in the Update System.\n@optional {Tag: any # Optional. Filter clients by Tag. Wildcards are supported (*)., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Clients/{ID}\n@desc Get a Client in the Update System.\n@required {ID: any # The Client ID}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Clients/{ID}\n@desc Update a Client.\n@required {ID: any # The Client ID, client: map # Updated Client Object.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Clients/{ID}/UpdateGroupSubscriptions\n@desc Get a Client's Current Update Group Subscriptions\n@required {ID: any # The Client ID}\n@optional {UpdateGroupID: any # Optional. Filter by Update Group., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Clients/{ID}/AvailableUpdateGroupSubscriptions\n@desc Get a Client's Available Update Group Subscriptions\n@required {ID: any # The Client ID}\n@optional {UpdateGroupID: any # Optional. Filter by Update Group., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/ContentDefinitions\n@desc Get ContentDefinitions\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., userID: any # Optional. Filter by UserID., includeAttributes: any # 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: any # Optional. Filter by Name. Supports beginning and ending wildcard (*)., typeID: any # Optional. Filter by TypeID., packageTypeID: any # Optional. Filter by PackageTypeID.}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentDefinitions\n@desc Create a ContentDefinition\n@required {contentDefinition: map # The ContentDefinition to create.}\n@returns(200) OK\n\n@endpoint GET /api/v2/ContentDefinitions/{contentDefinitionID}\n@desc Get a ContentDefinition by ID\n@required {contentDefinitionID: any # The ID of the ContentDefinition to get.}\n@optional {includeAttributes: any # 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.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/ContentDefinitions/{contentDefinitionID}\n@desc Update a ContentDefinition\n@required {contentDefinitionID: any # The ID of the ContentDefinition to update, contentDefinition: map # The updated ContentDefinition}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/ContentDefinitions/{contentDefinitionID}\n@desc Delete a ContentDefinition\n@required {contentDefinitionID: any # The ID of the ContentDefinition to delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/ContentDefinitions/{contentDefinitionID}/Attributes\n@desc Get Attributes for a ContentDefinition\n@required {contentDefinitionID: any # The ID of the ContentDefinition.}\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., name: any # Optional. Filter the attributes by Name.}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentDefinitions/{contentDefinitionID}/Attributes\n@desc Add an Attribute to a ContentDefinition\n@required {contentDefinitionID: any # The ID of the ContentDefinition, contentDefinitionAttribute: map # The Attribute to add.}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentDefinitions/{contentDefinitionID}/Attributes/Batch\n@desc No Documentation Found.\n@required {contentDefinitionID: any, contentDefinitionAttributes: [map]}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/ContentDefinitionAttributes/{contentDefinitionAttributeID}\n@desc Update an Attribute for a ContentDefinition\n@required {contentDefinitionAttributeID: any # The ID of the Attribute to update., contentDefinitionAttribute: map # The Attribute to update.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/ContentDefinitionAttributes/{contentDefinitionAttributeID}\n@desc Remove an Attribute from a ContentDefinition\n@required {contentDefinitionAttributeID: any # The ID of the Attribute to remove.}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/ContentDefinitionAttributes/Batch\n@desc No Documentation Found.\n@required {contentDefinitionAttributes: [map]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/ContentReleases\n@desc Get ContentReleaseVersion\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., deleted: any # Optional. Filter by deleted., releaseID: any # Optional. Filter by releaseID., userId: any # Optional. Filter by UserID., contentDefinitionID: any # Optional. Filter by ContentDefinitionID., version: any # Optional. Filter by Version.}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentReleases\n@desc Create a ContentReleaseVersion\n@required {contentReleaseVersion: map # The ContentReleaseVersion to create.}\n@returns(200) OK\n\n@endpoint GET /api/v2/ContentReleases/{ContentReleaseId}\n@desc Get a Content Release Version by ID\n@required {ContentReleaseId: any # The ID of the ContentReleaseVersion to get.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/ContentReleases/{ContentReleaseId}\n@desc Update a ContentReleaseVersion\n@required {ContentReleaseId: any # The ID of the ContentReleaseVersion to update, contentReleaseVersion: map # The updated ContentReleaseVersion}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/ContentReleases/{ContentReleaseId}\n@desc Delete a ContentReleaseVersion\n@required {ContentReleaseId: any # The ID of the ContentReleaseVersion to delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/ContentSubmissions\n@desc Get ContentSubmissions\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., userID: any # Optional. Filter by UserID., contentDefinitionID: any # Optional. Filter by ContentDefinitionID, includeAttributes: any # 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: any # Optional. Filter the submissions by whether they are part of the Release with the specified Release ID., typeID: any # Optional. Filter submissions by their ContentDefinition's Type ID., version: any # Optional. Filter submissions by their Version., includeDefinition: any # Optional. If true, includes the ContentDefinition for each submission.}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentSubmissions\n@desc Create a ContentSubmission\n@required {contentSubmission: map # The ContentSubmission to create.}\n@returns(200) OK\n\n@endpoint GET /api/v2/ContentSubmissions/{contentSubmissionID}\n@desc Get a ContentSubmission by ID\n@required {contentSubmissionID: any # The ID of the ContentSubmission to get.}\n@optional {includeAttributes: any # Names of Attributes to include when retrieving this submission. This should be a comma-separated list.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/ContentSubmissions/{contentSubmissionID}\n@desc Update a ContentSubmission\n@required {contentSubmissionID: any # The ID of the ContentSubmission to update, contentSubmission: map # The updated ContentSubmission}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/ContentSubmissions/{contentSubmissionID}\n@desc Delete a ContentSubmission\n@required {contentSubmissionID: any # The ID of the ContentSubmission to delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/ContentSubmissions/{contentSubmissionID}/Status\n@desc Get the status of a ContentSubmission\n@required {contentSubmissionID: any # The ID of the ContentSubmission to get.}\n@optional {includeActivityRunDetails: any # True to include all status details if JobRun. Defaults to false}\n@returns(200) OK\n\n@endpoint GET /api/v2/ContentSubmissions/{contentSubmissionID}/Attributes\n@desc Get Attributes for a ContentSubmission\n@required {contentSubmissionID: any # The ID of the ContentSubmission.}\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., name: any # Optional. Filter the attributes by Name.}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentSubmissions/{contentSubmissionID}/Attributes\n@desc Add an Attribute to a ContentSubmission\n@required {contentSubmissionID: any # The ID of the ContentSubmission, contentSubmissionAttribute: map # The Attribute to add.}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentSubmissions/{contentSubmissionID}/Attributes/Batch\n@desc No Documentation Found.\n@required {contentSubmissionID: any, contentSubmissionAttributes: [map]}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/ContentSubmissionAttributes/{contentSubmissionAttributeID}\n@desc Update an Attribute for a ContentSubmission\n@required {contentSubmissionAttributeID: any # The ID of the Attribute to update., contentSubmissionAttribute: map # The Attribute to update.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/ContentSubmissionAttributes/{contentSubmissionAttributeID}\n@desc Remove an Attribute from a ContentSubmission\n@required {contentSubmissionAttributeID: any # The ID of the Attribute to remove.}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/ContentSubmissionAttributes/Batch\n@desc No Documentation Found.\n@required {contentSubmissionAttributes: [map]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/ContentSubmissionTypes\n@desc Returns available Content Submission Types.\n@optional {enabled: any}\n@returns(200) OK\n\n@endpoint POST /api/v2/ContentSubmissionTypes\n@desc Add a Content Submission Type\n@required {contentSubmissionType: map # The Content Submission Type}\n@returns(200) OK\n\n@endpoint GET /api/v2/ContentSubmissionTypes/{id}\n@desc Retrieves a Content Submission Type by its ID.\n@required {id: any # The ID of the Content Submission Type}\n@returns(200) OK\n\n@endpoint PUT /api/v2/ContentSubmissionTypes/{id}\n@desc Update a Content Submission Type\n@required {id: any # The ID of the Content Submission Type, contentSubmissionType: map # The Content Submission Type}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/ContentSubmissionTypes/{id}\n@desc Remove a Content Submission Type\n@required {id: any # The ID of the Content Submission Type}\n@returns(204) No Content\n\n@endpoint GET /api/v2/DealerByCountry\n@desc Get a total count of dealers per country\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Dealers/{DealerCode}\n@desc Lookup a dealer using a dealer code.\n@required {DealerCode: any # The Dealer Code to Search for}\n@returns(200) OK\n\n@endpoint GET /api/v2/Dealers\n@desc Get a list of dealers.\n@optional {Brand: any # The brand to filter by., ShippingCountry: any # The country to filter by., DealerName: any # The partial Dealer Name to filter by. Wildcard supported (*)., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Files\n@desc Get a paged response of file metadata.\n@optional {includeDeleted: any # Indicates whether to include files marked as removed., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Files\n@desc Create the metadata for a file before uploading. The State of the File should be 'Created'.\n@required {file: map # The file's metadata.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Files/{ID}\n@desc Gets a file's metadata.\n@required {ID: any}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Files/{ID}\n@desc Update the metadata for a file. Size may not be modified by the client.\n@required {ID: any # The file's id, file: map # The file's metadata}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Files/{ID}\n@desc Mark a file as 'Removed'. Disables download of the file and hides metadata from GET all method\n@required {ID: any # The file's id.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Files/{ID}/FileContents\n@desc Download the contents of a file. The current State of the File should be 'Available'.\n@required {ID: any # The file's metadata.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Files/{ID}/FileContents\n@desc Upload the contents of a file. The current State of the File should be 'Created'.\n@required {ID: any # The file's metadata.}\n@returns(200) OK\n\n@endpoint GET /api/v2/FileUploadIndexFields\n@desc Get File Upload Index Fields\n@optional {limit: any # Optional. Limit number of results returned. The default value is 10., offset: any # Optional. Offset for the results returned. The default value is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/FileUploads/Report\n@desc Build a report from file uploads\n@required {query: map}\n@returns(200) OK\n\n@endpoint GET /api/v2/FileUploadTypes\n@desc Get File Upload Types\n@optional {limit: any # Optional. Limit number of results returned. The default value is 10., offset: any # Optional. Offset for the results returned. The default value is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/GlobalImageCategories\n@desc Get a paged response of file metadata.\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/GlobalImageCategories\n@desc Create the metadata for a file before uploading. The State should be 'Created'.\n@required {file: map # The file's metadata.}\n@returns(200) OK\n\n@endpoint GET /api/v2/GlobalImageCategories/{ID}\n@desc Gets a file's metadata.\n@required {ID: any # The file's id.}\n@returns(200) OK\n\n@endpoint GET /api/v2/GlobalImages\n@desc Get a paged response of GlobalImage.\n@optional {search: any # Optional. Searches for matching global images with the matching Category Name, Publisher or Description, categoryId: any, publisher: any, includeDeleted: any # Indicates whether to include GlobalImages marked as removed., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., state: any # Optional. Filter to include only images with a state matching the provided value., afterDate: any # Optional. Filter to include only images with a 'Date' after the provided value.}\n@returns(200) OK\n\n@endpoint POST /api/v2/GlobalImages\n@desc Create the metadata for a GlobalImage before uploading. The State should be 'Created'.\n@required {globalImage: map # The file's metadata.}\n@optional {overridePublisherOrDate: any # Whether to set the publisher and date to the provided values.}\n@returns(200) OK\n\n@endpoint GET /api/v2/GlobalImages/{ID}\n@desc Gets a GlobalImage's metadata.\n@required {ID: any # The GlobalImage's id.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/GlobalImages/{ID}\n@desc Update the metadata for an image.\n@required {ID: any # The GlobalImage's id., globalImage: map # The GlobalImage's metadata}\n@optional {overridePublisherOrDate: any # Whether to set the publisher and date to the provided values.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/GlobalImages/{ID}\n@desc Mark a file as 'Removed'. Disables download of the image and hides metadata from GET all method\n@required {ID: any # The GlobalImage's id.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/GlobalImages/{ID}/ImageContents\n@desc Download the contents of a GlobalImage. The current State of the GlobalImage should be 'Available'.\n@required {ID: any # The global image metadata id.}\n@optional {isFullImage: any # Indicated whether to download the full image or the thumbnail. Defaults to 'true'.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/GlobalImages/{ID}/ImageContents\n@desc Upload the contents of a GlobalImage. The current State of the File for the GlobalImage should be 'Created'.\n@required {ID: any # The global image metadata id.}\n@optional {isFullImage: any # Indicated whether this is the full image or the thumbnail. Defaults to 'true'.}\n@returns(200) OK\n\n@endpoint GET /api/v2/jobRuns\n@desc Get JobRuns\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., includeActivityRunDetails: any # Optional. Indicates whether to include ActivityRun details.  Defaults to false.}\n@returns(200) OK\n\n@endpoint POST /api/v2/jobRuns\n@desc Create a JobRun\n@required {jobRun: map # The JobRun to create.  The JobRunID will be assigned on creation of the JobRun.}\n@returns(200) OK\n\n@endpoint GET /api/v2/jobRuns/{jobRunID}\n@desc Get a JobRun by ID\n@required {jobRunID: any # The ID of the JobRun to get.}\n@optional {includeActivityRunDetails: any # Optional. Indicates whether to include ActivityRun details.  Defaults to false.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/jobRuns/{jobRunID}\n@desc Update a JobRun\n@required {jobRunID: any # The id of the JobRun to update, jobRun: map # The updated JobRun}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/jobRuns/{jobRunID}\n@desc Delete a JobRun\n@required {jobRunID: any # The id of the JobRun to delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/jobs\n@desc Get Jobs\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., isIncludeDeleted: any # Does it include deleted job, or not}\n@returns(200) OK\n\n@endpoint POST /api/v2/jobs\n@desc Create a Job\n@required {job: map # The job to create.  The JobID will be assigned on creation of the Job.}\n@returns(200) OK\n\n@endpoint GET /api/v2/jobs/{jobID}\n@desc Get a Job by ID\n@required {jobID: any # The ID of the Job to get.}\n@optional {isIncludeDeleted: any # Does it include deleted job, or not}\n@returns(200) OK\n\n@endpoint PUT /api/v2/jobs/{jobID}\n@desc Update a Job\n@required {jobID: any # The id of the job to update, job: map # The updated job}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/jobs/{jobID}\n@desc Mark the delete flag for the Job\n@required {jobID: any # The id of the job to delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Languages\n@desc Get a list of the languages for which translations are supported. Returns a PagedResponse of Language objects.\n@optional {limit: any # limit the number of Language objects returned. Optional (defaults to 10)., offset: any # the number of Language objects to skip. Optional (defaults to 0)., includeDeleted: any # whether to include languages marked as deleted. Defaults to false}\n@returns(200) OK\n\n@endpoint POST /api/v2/Languages\n@desc Add a Language to support for translations. Accepts a Language object. Returns the Id of the created object.\n@required {language: map}\n@returns(200) OK\n\n@endpoint GET /api/v2/Languages/{LocaleID}\n@desc Get a language by its id. Returns a Language object\n@required {LocaleID: any}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Languages/{LocaleID}\n@desc Update a language’s description. Accepts a Language object.\n@required {LocaleID: any, language: map}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Languages/{LocaleID}\n@desc Remove a Language from those supported for translations. Marks language as deleted.\n@required {LocaleID: any}\n@returns(204) No Content\n\n@endpoint POST /api/v2/LicenseActivations\n@desc Create a license activation.\n@required {licenseActivationCreate: map # The data required for creating the license.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/LicenseActivations/{ID}\n@desc Update a license activiation.\n@required {ID: any # The ID of the license., licenseActivationUpdate: map # The data required for updating the license.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/LicenseActivations/{ID}/Confirm\n@desc Confirm that the client has applied the updated license.\n@required {ID: any # The ID of the license, licenseActivationConfirm: map # The license data.}\n@returns(204) No Content\n\n@endpoint POST /api/v2/LicenseActivations/RegisterEDTLite\n@desc Register an EDT Lite with the Server\n@required {edtLiteRegistration: map # The information required for registration.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Licenses\n@desc Gets a list of licenses with the specified criteria.\n@optional {VoucherCode: any # Optional. Filter by VoucherCode, DealerCode: any # Optional. Filter by DealerCode, Status: any # Optional. Filter by Status.  By default only active licenses will be returned., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Licenses/{ID}\n@desc Get a license.\n@required {ID: any # The ID of the license to get.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Logs\n@desc Get the API System logs, most recent first.\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Logs\n@desc Add a Log entry\n@required {Message: any # Message to enter into the log}\n@returns(200) OK\n\n@endpoint GET /api/v2/Logs/{ID}\n@desc Get a log by ID\n@required {ID: any # The Log ID}\n@returns(200) OK\n\n@endpoint POST /api/v2/Notifications\n@desc Sends an email message.\n@required {Notification: map # The Notification Object.}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/Clients/{ClientID}/PackageReports/Batch\n@desc Submit a batch of package reports\n@required {ClientID: any # The Client ID, packageReports: [map] # The Package Reports}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Clients/{ClientID}/PackageReports\n@desc Get the package reports for a client.\n@required {ClientID: any # The Client ID}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Clients/{ClientID}/PackageReports\n@desc Submit a package report\n@required {ClientID: any # The Client ID, packageReport: map # The Package Report}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Packages\n@desc List Packages.\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., PackageTypeID: any # Optional. If provided, filters by PackageTypeID., Version: any # Optional. If provided, filters by Version., Released: any # Optional. If provided, filters by Released.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Packages\n@desc Add a Package to the Update System.\n@required {package: map # The package to add.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Packages/{ID}\n@desc Find a Package.\n@required {ID: any # The Package ID to Search for}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Packages/{ID}\n@desc Modify a Packge to the Update System.\n@required {ID: any # The unique ID of the Package, package: map # The package to update.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Packages/{ID}\n@desc Delete a Package.\n@required {ID: any # The Package ID to Delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/PackageTypes\n@desc Get all of the Package Types.\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., userID: any # Optional. The user ID to sort packageTypes by the user's access}\n@returns(200) OK\n\n@endpoint POST /api/v2/PackageTypes\n@desc Add a Package Type.\n@required {PackageType: map # The Package Type to add}\n@returns(200) OK\n\n@endpoint GET /api/v2/PackageTypes/{ID}\n@desc Get a specific Package Type.\n@required {ID: any # The Package Type ID}\n@returns(200) OK\n\n@endpoint PUT /api/v2/PackageTypes/{ID}\n@desc Modify a Package Type.\n@required {ID: any # The ID of the Package Type, PackageType: map # The Package Type to update}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/PackageTypes/{ID}\n@desc Delete a Package Type.\n@required {ID: any # The Package Type ID}\n@returns(204) No Content\n\n@endpoint POST /api/v2/PackageTypes/{id}/Users/{userID}\n@desc Add a package type that a user can see.\n@required {id: any # The ID of the Package Type, userID: any # The userID to link to the package type}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/PackageTypes/{id}/Users/{userID}\n@desc Deletes a package type a user could see.\n@required {id: any # The ID of the Package Type, userID: any # The userID to link to the package type}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/Bundles/{bundleID}/PackageTypetoBundles/Batch\n@desc Update multiple Package Type ID to Bundle Relationships.\n@required {bundleID: any, PackageTypeToBundles: [map]}\n@returns(204) No Content\n\n@endpoint POST /api/v2/Bundles/{bundleID}/PackageTypetoBundles/Batch\n@desc No Documentation Found.\n@required {bundleID: any, PackageTypeToBundles: [map]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/PackageTypetoBundles\n@desc Get all of the Package Type to Bundle Relationships.\n@optional {BundleID: any # Optional. Filter by BundleID., PackageTypeID: any # Optional. Filter by PackageTypeID., PackageVersion: any # Optional. Filter by PackageVersion., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/PackageTypetoBundles\n@desc Update a Package Type ID to Bundle Relationship.\n@required {PackageTypeToBundle: map # The PackageTypeToBundle to update.}\n@returns(204) No Content\n\n@endpoint POST /api/v2/PackageTypetoBundles\n@desc Add a new Package Type ID to Bundle Relationship.\n@required {PackageTypeToBundle: map # The PackageTypeToBundle to add.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/PackageTypetoBundles\n@desc Delete a Package Type to Bundle Relationship.\n@required {BundleID: any # The BundleID, PackageTypeID: any # The PackageTypeID}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Permissions\n@desc List Permissions\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., name: any # Filter by permission name. Supports ending wildcard (*). Optional.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Permissions\n@desc Adds a Permission\n@required {permission: map # Permission to add}\n@returns(200) OK\n\n@endpoint GET /api/v2/Permissions/{id}\n@desc Gets a Permission\n@required {id: any # Id of Permission}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Permissions/{id}\n@desc Updates a Permission\n@required {id: any # Id of Permission, permission: map # The Updated Permission}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Permissions/{id}\n@desc Deletes a Permission\n@required {id: any # Id of Permission}\n@returns(204) No Content\n\n@endpoint GET /api/v2/PriorityPackages\n@desc Get a list of Priority Packages by Client.\n@optional {ClientID: any # Optional. Filter priority packages by ClientID., Status: any # Optional. Filter returned packages by status. By default only active packages will be returned., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/PriorityPackages\n@desc Add a Priority Package for a Client.\n@required {Package: map # The PriorityPackage to add}\n@returns(200) OK\n\n@endpoint GET /api/v2/PriorityPackages/{ID}\n@desc Get a Priority Packages for a Client.\n@required {ID: any # The Priority Package ID}\n@returns(200) OK\n\n@endpoint DELETE /api/v2/PriorityPackages/{ID}\n@desc Delete a Priority Package for a Client.\n@required {ID: any # The Priority Package ID}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Releases\n@desc Get Release\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., visible: any # Optional. Filter by visible., bundleID: any # Optional. Filter by BundleID.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Releases\n@desc Create a Release\n@required {release: map # The Release to create.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Releases/{ReleaseId}\n@desc Get a  Release by ID\n@required {ReleaseId: any # The ID of the Release to get.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Releases/{releaseId}\n@desc Update a Release\n@required {releaseId: any # The ID of the Release to update, release: map # The updated Release}\n@returns(204) No Content\n\n@endpoint POST /api/v2/Releases/{ReleaseId}/Bundle/{BundleId}\n@desc Associates the release with a bundle.\n@required {ReleaseId: any # The release identifier., BundleId: any # The bundle identifier.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Releases/{ReleaseId}/Bundle/{BundleId}\n@desc Deletes the association between a release and a bundle.\n@required {ReleaseId: any # The release identifier., BundleId: any # The bundle identifier.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Reporting/GetClient\n@desc Get a Client in the Update System.\n@required {ID: any # The Client ID}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/ClientInfo\n@desc Get Client Information\n@required {ClientID: any # The Client ID}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/GetSubscriptions\n@desc Get a list of current Client Subscriptions.\n@optional {ClientID: any # Optional. Filter by Client ID, UpdateGroupID: any # Optional. Filter by Update Group ID, limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/RegisteredClients\n@desc Get a list of subscribed clients\n@optional {UpdateGroupID: any # 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: any # Optional. Filter where ClientID matches a value. Wildcards are supported (*)., Tag: any # Optional. Filter where Tag matches a value. Wildcards are supported (*)., ReportResult: any # Optional and UpdateGroupID must be included. Filter where ReportResult matches a value. Wildcards are supported (*)., ReportResultIsValid: any # 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: any # Optional and UpdateGroupID must be included. Filter where ReportValue matches a value. Wildcards are supported (*)., LastCheckInBefore: any # Optional. Filter where LastCheckIn occured before the provided date., LastCheckInAfter: any # Optional. Filter where LastCheckIn occured after the provided date., OrderBy: any # Optional. Specify the order in which results should be returned. Use this format: [FieldName] [ASC|ASCENDING|DESC|DESCENDING],...   \r             If sort direction is not provided for a field, it will be sorted ascending., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/UpdateGroups\n@desc Get a list of Update Groups.  Update Groups are used by the client to register for a specific type of update.\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/PackageStatusSummary\n@desc Get a summary report for a Specific Package\n@required {PackageID: any # The Package ID}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/BundleStatusSummary\n@desc Get a summary of all Packages in a Bundle\n@required {BundleID: any # The BundleID}\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/BundlesInUpdateGroup\n@desc Get a list of bundles for UpdateGroup.\n@required {ID: any # The UpdateGroupID, IncludeInactive: any # Include Inactive Bundles (true|false)}\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/CurrentPackagesInUpdateGroup\n@desc Get the current packages for an update group.\n@required {ID: any # The UpdateGroupID}\n@optional {SubscriptionTypeFilter: any # Optional.  The subscription type filter to use.  By default the Default packages (Required and IncludeByDefault) will be returned.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Reporting/UpdateMetrics\n@desc Get data for pie charts in UpdateMetrics.\n@required {UpdateGroupID: any # The UpdateType in which clients must be for the report to include them.}\n@optional {bundleNumber: any # Optional. Tells us which chart to show based upon filter.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Roles\n@desc List Roles\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., name: any # Optional. Finds a role with the given name., permissionID: any, permissionName: any # Optional. Filters roles by whether they contain the provided permission.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Roles\n@desc Adds a User Role\n@required {role: map # Role to add}\n@returns(200) OK\n\n@endpoint GET /api/v2/Roles/{id}\n@desc Gets a User Role\n@required {id: any # The role's id}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Roles/{id}\n@desc Updates a User Role\n@required {id: any # The role's id, role: map # The Updated Role}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Roles/{id}\n@desc Deletes a User Role\n@required {id: any # The role's id}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Roles/{id}/Permissions\n@desc Get the Permissions for a Role\n@required {id: any # The id of the Role}\n@optional {name: any # Filter by permission name. Optional., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Roles/{id}/Permissions\n@desc Manage the Permissions for a Role\n@required {id: any # The id of the Role, permissionChanges: [map] # Permissions Changes for the Role}\n@returns(204) No Content\n\n@endpoint GET /api/v2/steps\n@desc Get Steps\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., includeDeleted: any # Does it include deleted step, or not}\n@returns(200) OK\n\n@endpoint POST /api/v2/steps\n@desc Create a Step\n@required {step: map # The step to create}\n@returns(200) OK\n\n@endpoint GET /api/v2/steps/{stepID}\n@desc Get a Step by ID\n@required {stepID: any # The ID of the Step to get.}\n@optional {isIncludeDeleted: any # Does it include deleted step, or not}\n@returns(200) OK\n\n@endpoint PUT /api/v2/steps/{stepID}\n@desc Update a Step\n@required {stepID: any # The step ID of the step to update, step: map # The updated step}\n@returns(204) No Content\n\n@endpoint GET /api/v2/StringDefinitions\n@desc Get a paged response of Global String Definitions.\n@optional {limit: any # Optional. The page limit. The default page limit is 10. Ignored if 'stringIds' is provided., modifiedAfterTimestamp: any # Optional. Return only the StringDefinition objects that have a Timestamp value greater than that provided. This will be an encoded byte array., includeTranslations: any # Optional. Indicates whether to include the StringTranslations for the StringDefinition. Defaults to false., stringText: any # 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: any # 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: any # Optional. This flag is used to determin whether to use the FullText Search or not., includeDeletedLanguages: any # Optional. Indicates whether to include languages marked as deleted. includeTranslations must be true. Defaults to false., languageIds: any # 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: any # 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: any # Optional. If false, all translations for returned String Definitions are included. Must be used with 'stringText' provided and 'includeTranslations' = true.}\n@returns(200) OK\n\n@endpoint GET /api/v2/StringDefinitions/{ID}\n@desc Get a paged response of Global String Definitions.\n@required {ID: any}\n@optional {includeTranslations: any # Optional. Indicates whether to include the StringTranslations for the StringDefinition. Defaults to false., includeDeletedLanguages: any # Optional. Indicates whether to include languages marked as deleted. includeTranslations must be true. Defaults to false., languageIds: any # 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.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/StringDefinitions/Batch\n@desc 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.\n@required {stringDefinitions: [map] # The Array of Definitions to update}\n@returns(204) No Content\n\n@endpoint POST /api/v2/StringDefinitions/Batch\n@desc Create StringDefinition object. The originating translation must be provided. Accepts an array of StringDefinition objects. Returns nothing.\n@required {stringDefinitions: [map] # The StringDefinition Object array, along with originating translation.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/StringTranslations\n@desc Get a paged response of Global String Translations.\n@optional {limit: any # Optional. The page limit. The default page limit is 10., modifiedAfterTimestamp: any # Optional. Return only StringTranslation objects that have a Timestamp value greater than that provided. This will be an encoded byte array., state: any # Optional. Return only StringTranslation objects with a matching State.}\n@returns(200) OK\n\n@endpoint GET /api/v2/StringTranslations/{stringId}/{languageId}\n@desc Get a single translation based upon stringId and languageId\n@required {stringId: any, languageId: any}\n@returns(200) OK\n\n@endpoint PUT /api/v2/StringTranslations/{stringId}/{languageId}\n@desc Update a string value or a state for a string translation.\n@required {stringId: any, languageId: any, stringTranslation: map}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/StringTranslations/Batch\n@desc Update corrections to string translations\n@required {stringTranslations: [map]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/TranslationKeys\n@desc Get a paged response of TranslationKeys.\n@optional {limit: any, offset: any, keyNames: any # Can filter by keyNames, a comma deliminated list.}\n@returns(200) OK\n\n@endpoint POST /api/v2/TranslationKeys\n@desc Create a translationKey object.\n@required {translationKey: map}\n@returns(200) OK\n\n@endpoint GET /api/v2/TranslationKeys/{ID}\n@desc Get TranslationKey by ID\n@required {ID: any}\n@returns(200) OK\n\n@endpoint PUT /api/v2/TranslationKeys/{ID}\n@desc Update the StringID of the translationKey object.\n@required {ID: any, translationKey: map}\n@returns(204) No Content\n\n@endpoint GET /api/v2/TranslationRequests\n@desc Get all TranslationRequest objects. Returns a PagedResponse of TranslationRequest objects with their language ids and string ids.\n@optional {limit: any, offset: any}\n@returns(200) OK\n\n@endpoint POST /api/v2/TranslationRequests\n@desc Create a translation request. Accepts a TranslationRequest object. Returns the Id of the created object. The state of the TranslationRequest must be ‘NotSubmitted’.\n@required {translationRequest: map}\n@returns(200) OK\n\n@endpoint GET /api/v2/TranslationRequests/{Id}\n@desc Get a TranslationRequest object by id. Returns TranslationRequest object with its language ids and string ids.\n@required {Id: any}\n@returns(200) OK\n\n@endpoint PUT /api/v2/TranslationRequests/{Id}\n@desc Update a TranslationRequest object by id. Accepts a TranslationRequest object.\n@required {Id: any, translationRequest: map}\n@optional {doResendRequest: any}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/TranslationRequests/{Id}/Strings\n@desc No Documentation Found.\n@required {Id: any, StringIds: [str]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/TranslationSets\n@desc Get a PagedResponse of TranslationSet objects. Related TranslationSetStrings are NOT returned\n@optional {limit: any, offset: any, translationRequestID: any, state: any, stringId: any, languageId: any, includeAttributes: any # 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.}\n@returns(200) OK\n\n@endpoint GET /api/v2/TranslationSets/{ID}\n@desc Get a TranslationSet object by its id. Related TranslationSetStrings are NOT returned.\n@required {ID: any}\n@optional {includeAttributes: any # 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.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/TranslationSets/{ID}\n@desc Update a Translation Set. Accepts a TranslationSet object. Only the state property may be updated.\n@required {ID: any, translationSet: map}\n@returns(204) No Content\n\n@endpoint GET /api/v2/TranslationSets/{ID}/Strings\n@desc Get a PagedResponse of TranslationSetString objects\n@required {ID: any}\n@optional {limit: any, offset: any}\n@returns(200) OK\n\n@endpoint PUT /api/v2/TranslationSets/{ID}/Strings\n@desc No Documentation Found.\n@required {ID: any, translationSetStrings: [map]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/TranslationSets/{ID}/SourceStrings\n@desc Gets the information needed to translate a string in a translation set\n@required {ID: any}\n@optional {limit: any, offset: any}\n@returns(200) OK\n\n@endpoint GET /api/v2/TranslationSets/{ID}/Statistics\n@desc Gets the statistics for translation sets such as the language ids and count of string definitions.\n@required {ID: any}\n@returns(200) OK\n\n@endpoint GET /api/v2/TranslationSets/{ID}/Attributes\n@desc Get a PagedResponse of TranslationSetAttribute objects\n@required {ID: any}\n@optional {limit: any, offset: any, name: any}\n@returns(200) OK\n\n@endpoint POST /api/v2/TranslationSets/{ID}/Attributes\n@desc Create a TranslationSetAttribute object\n@required {ID: any, translationSetAttribute: map}\n@returns(200) OK\n\n@endpoint PUT /api/v2/TranslationSetAttributes/{ID}\n@desc Update a TranslationSetAttribute object\n@required {ID: any, translationSetAttribute: map}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/TranslationSetAttributes/{ID}\n@desc Delete a set of TranslationSetAttribute object\n@required {ID: any}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/TranslationSetAttributes/Batch\n@desc No Documentation Found.\n@required {translationSetAttributes: [map]}\n@returns(204) No Content\n\n@endpoint POST /api/v2/TranslationSets/{ID}/Attributes/Batch\n@desc No Documentation Found.\n@required {ID: any, translationSetAttributes: [map]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/UpdateGroupClientRelationships\n@desc Get a list of current Client Subscriptions.\n@optional {ClientID: any # Optional. Filter by Client ID, UpdateGroupID: any # Optional. Filter by Update Group ID, limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., Active: any # Optional. Filter by Active}\n@returns(200) OK\n\n@endpoint PUT /api/v2/UpdateGroupClientRelationships\n@desc DEPRECATED. Set client subscription status for an update group.\n@required {ClientID: any # The Client ID.  This can be a client ID that has not been registered yet., UpdateGroupID: any # The Update Group ID, Active: any # Subscribe the client to the Update Group.}\n@returns(204) No Content\n\n@endpoint POST /api/v2/UpdateGroupClientRelationships\n@desc Add a subscription\n@required {subscription: map # The UpdateGroupClientRelationship to add.}\n@returns(200) OK\n\n@endpoint GET /api/v2/UpdateGroupClientRelationships/{RelationshipID}\n@desc Get a subscription by RelationshipID\n@required {RelationshipID: any # The RelationshipID.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/UpdateGroupClientRelationships/{RelationshipID}\n@desc Updates a Subscription\n@required {RelationshipID: any # The relationship id of the UpdateGroupClientRelationship, subscription: map # The updated UpdateGroupClientRelationship}\n@returns(204) No Content\n\n@endpoint GET /api/v2/UpdateGroups\n@desc Get a list of Update Groups.  Update Groups are used by the client to register for a specific type of update.\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0., userID: any # Optional. The user ID to sort update groups by the user's access}\n@returns(200) OK\n\n@endpoint POST /api/v2/UpdateGroups\n@desc Add a new Update Group.  The report field is a string that has a dot based request for a specific piece of submitted data.\n@required {updateGroup: map}\n@returns(200) OK\n\n@endpoint GET /api/v2/UpdateGroups/{ID}\n@desc Get a specific Update Group by ID.\n@required {ID: any # The ID of the Update Group}\n@returns(200) OK\n\n@endpoint PUT /api/v2/UpdateGroups/{ID}\n@desc Modify an Update Group.\n@required {ID: any # ID of the Update Group, updateGroup: map # The Update Group to update.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/UpdateGroups/{ID}\n@desc Delete an Update Group.\n@required {ID: any # The ID of the Update Group to Delete}\n@returns(204) No Content\n\n@endpoint POST /api/v2/UpdateGroups/{id}/Users/{userID}\n@desc Add an updateGroup that a user can see.\n@required {id: any # The ID of the update group, userID: any # The userID to link to the update group}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/UpdateGroups/{id}/Users/{userID}\n@desc Deletes an update group a user could see.\n@required {id: any # The ID of the update group, userID: any # The userID to link to the update group}\n@returns(204) No Content\n\n@endpoint GET /api/v2/UpdateGroupSubscriptions\n@desc Get Update Group Subscriptions\n@optional {UpdateGroupID: any # Optional. Filter by Update Group ID., PackageTypeID: any # Optional. Filter by Package Type ID., ClientID: any # Optional. Filter by Client ID., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/UpdateGroupSubscriptions\n@desc Add an Update Group Subscription\n@required {UpdateGroupSubscription: map # The Update Group Subscription to add}\n@returns(200) OK\n\n@endpoint GET /api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}\n@desc Get an Update Group Subscription\n@required {UpdateGroupSubscriptionID: any # The Update Group Subscription ID}\n@returns(200) OK\n\n@endpoint PUT /api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}\n@desc Update an Update Group Subscription\n@required {UpdateGroupSubscriptionID: any # The Update Group Subscription ID, UpdateGroupSubscription: map # The updated Update Group Subscription}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/UpdateGroupSubscriptions/{UpdateGroupSubscriptionID}\n@desc Delete an Update Group Subscription\n@required {UpdateGroupSubscriptionID: any # The Update Group Subscription ID to delete}\n@returns(204) No Content\n\n@endpoint PUT /api/v2/UpdateGroupSubscriptions/Batch\n@desc No Documentation Found.\n@required {UpdateGroupSubscriptions: [map]}\n@returns(204) No Content\n\n@endpoint POST /api/v2/UpdateGroupSubscriptions/Batch\n@desc No Documentation Found.\n@required {UpdateGroupSubscriptions: [map]}\n@returns(204) No Content\n\n@endpoint GET /api/v2/UpdateSystem\n@desc Checks the Client ID into the Update System.\n@required {ClientID: any # The Client ID to check-in.  If this is a new client ID it will be added to Clients., Preview: any # Get Pkgs w\\o updating Datetimes(true|false)}\n@optional {RunAllInventories: any # Force return inventories. Defaults to false., transactionID: any # Optional. The 'NextTransactionID' from the previous check-in. Used to detect duplicate client IDs.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Clients/{ClientID}/CachedFiles\n@desc Get a list of Cached Files installed on the client Machine.\n@required {ClientID: any # The ClientID of the Client, Expired: any # Only Expired Files (true|false)}\n@returns(200) OK\n\n@endpoint GET /api/v2/UserContentDefinitions\n@desc Get UserContentDefinitions\n@optional {limit: any # Optional. The page limit.  If not specified, the default page limit is 10., offset: any # Optional. The page offset.  If not specified, the default page offset is 0., userID: any # Optional. Filter by UserID., contentDefinitionID: any # Optional. Filter by ContentDefinitionID}\n@returns(200) OK\n\n@endpoint POST /api/v2/UserContentDefinitions\n@desc Create a UserContentDefinition\n@required {userContentDefinition: map # The UserContentDefinition to create.}\n@returns(200) OK\n\n@endpoint GET /api/v2/UserContentDefinitions/{userContentDefinitionID}\n@desc Get a UserContentDefinition by ID\n@required {userContentDefinitionID: any # The ID of the UserContentDefinition to get.}\n@returns(200) OK\n\n@endpoint DELETE /api/v2/UserContentDefinitions/{userContentDefinitionID}\n@desc Delete a UserContentDefinition\n@required {userContentDefinitionID: any # The ID of the UserContentDefinition to delete}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Users/{id}/Permissions\n@desc Get a user's permissions\n@required {id: any # The User's ID}\n@optional {Permission: any # Filter by permission name. Supports ending wildcard (*). Optional., limit: any # The page limit. The default page limit is 10., offset: any # The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Users/Current/Permissions\n@desc Get a user's permissions\n@optional {Permission: any # Filter by permission name. Supports ending wildcard (*). Optional., limit: any # The page limit. The default page limit is 10., offset: any # The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Users/{id}/Roles\n@desc Get a user's roles\n@required {id: any # The User's ID}\n@optional {Role: any # Filter by role name. Supports ending wildcard (*). Optional., limit: any # The page limit. The default page limit is 10., offset: any # The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Users/{id}/Roles\n@desc Update a user's roles\n@required {id: any # The User's ID, roleChanges: [map] # A list of changes to the User's Roles}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Roles/{id}/Users\n@desc Get all user's in a role\n@required {id: any # The Role's ID}\n@optional {limit: any # The page limit. The default page limit is 10., offset: any # The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Roles/{id}/Users\n@desc Update a Role's users\n@required {id: any # The Role's ID, roleChanges: [map] # A list of changes to the Role's Users}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Users/Current/Roles\n@desc Gets the current user's roles\n@optional {Role: any # Filter by role name. Supports ending wildcard (*). Optional., limit: any # The page limit. The default page limit is 10., offset: any # The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Users\n@desc Get users\n@optional {username: any # Optional. Search by username. Supports beginning and ending wildcards (*)., email: any # Optional. Search by email. Supports beginning and ending wildcards (*)., name: any # Optional. Search by name. Supports beginning and ending wildcards (*)., hasRole: any # Optional. Return only users having the provided role name., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Users\n@desc Create a user\n@required {user: map # The user to create.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Users/{id}\n@desc Get a specific user\n@required {id: any # The user ID}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Users/{id}\n@desc Update a user\n@required {id: any # The user id, user: map # The user}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Users/{id}\n@desc Delete a user\n@required {id: any # The user id}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Users/Current\n@desc Gets the current user\n@returns(200) OK\n\n@endpoint PUT /api/v2/Users/Current\n@desc Update a user\n@required {user: map # The user}\n@returns(204) No Content\n\n@endpoint GET /api/v2/VoucherHistory\n@desc Gets voucher history data\n@optional {VoucherCode: any # Optional. Filter history data by Voucher Code., ChangedBefore: any # Optional. Filter history data where changes occured before provided date., ChangedAfter: any # Optional. Filter history data where changes occured after provided date., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Vouchers\n@desc Gets a list of vouchers\n@optional {Type: any # Optional. Filter vouchers by Type, DealerCode: any # Optional. Filter vouchers by DealerCode, LicenseTo: any # Optional. Filter vouchers by LicenseTo. Wildcard supported (*)., Purpose: any # Optional. Filter vouchers by Purpose. Wildcard supported (*)., OrderNumber: any # Optional. Filter vouchers by OrderNumber, Email: any # Optional. Filter vouchers by Email. Wildcard supported (*)., ModifiedBy: any # Optional. Filter vouchers by ModifiedBy, CreatedAfter: any # Optional. Filter vouchers by CreatedDate, CreatedBefore: any # Optional. Filter vouchers by CreatedDate, PunchedAfter: any # Optional. Filter vouchers by PunchedDate, PunchedBefore: any # Optional. Filter vouchers by PunchedDate, Punched: any # Optional. Filter vouchers by Punched status, ExpirationAfter: any # Optional. Filter vouchers by ExpirationDate, ExpirationBefore: any # Optional. Filter vouchers by ExpirationDate, Deleted: any # Optional. Filter vouchers by Deleted state. By default only vouchers that are not deleted are returned., limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@endpoint POST /api/v2/Vouchers\n@desc Create a voucher\n@required {voucher: map # The voucher to add.}\n@returns(200) OK\n\n@endpoint GET /api/v2/Vouchers/{VoucherCode}\n@desc Get a voucher\n@required {VoucherCode: any # The voucher code of the voucher to get.}\n@optional {Deleted: any # Optional. Filter vouchers by Deleted state. By default only vouchers that are not deleted are returned.}\n@returns(200) OK\n\n@endpoint PUT /api/v2/Vouchers/{VoucherCode}\n@desc Update a voucher\n@required {VoucherCode: any # The voucher code of the voucher to update., voucher: map # The updated voucher.}\n@returns(204) No Content\n\n@endpoint DELETE /api/v2/Vouchers/{VoucherCode}\n@desc Delete a voucher\n@required {VoucherCode: any # The voucher code of the voucher to delete.}\n@returns(204) No Content\n\n@endpoint GET /api/v2/Vouchers/{VoucherCode}/VoucherHistory\n@desc Get a voucher's history.\n@required {VoucherCode: any # The voucher code to get history for.}\n@optional {limit: any # Optional. The page limit. The default page limit is 10., offset: any # Optional. The page offset. The default page offset is 0.}\n@returns(200) OK\n\n@end\n"}