Version 1.0
Connector Overview: This page documents all 380 actions for the Impartnerconnector v1.0.
Solution Member API (8)
PUT Adds a single or many Solutions based on the specified view model(s).
/prm/api/objects/v1/Solution
Create one or more solution records based on the provided view models. Use this action to insert single or batch solutions from the member perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution by id.
/prm/api/objects/v1/Solution/{id}
Permanently delete a specific solution record by its unique identifier. Use this action to remove an individual solution in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solutions by id.
/prm/api/objects/v1/Solution
Permanently delete multiple solution records at once in the member context. Use this action to perform bulk deletion of solutions by their identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solutions corresponding to the given data fields.
/prm/api/objects/v1/Solution
Retrieve a list of solution records matching data criteria provided in the request body. Use this action to search solutions using structured payload filters in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solutions corresponding to the given parameters.
/prm/api/objects/v1/Solution
Retrieve a list of solution records matching query parameters. Use this action to browse and filter solutions available to the member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution by id.
/prm/api/objects/v1/Solution/{id}
Retrieve a single solution record by its unique identifier. Use this action to view member-accessible details for a specific solution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution based on the specified view model.
/prm/api/objects/v1/Solution/{id}
Update specific fields of a solution record using the provided view model. Use this action to apply partial changes to an existing solution in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solutions based on the specified view models.
/prm/api/objects/v1/Solution
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionAttachment Admin API (9)
GET /api/objects/v1/SolutionAttachment/{id}/_view
/api/objects/v1/SolutionAttachment/{id}/_view
Retrieve the view representation for a specific solution attachment. Use this action to inspect attachment display and view model metadata in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Attachments based on the specified view model(s).
/api/objects/v1/SolutionAttachment
Create one or more solution attachments based on the specified view models. Use this action to associate single or multiple file attachments with solutions in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Attachment by id.
/api/objects/v1/SolutionAttachment/{id}
Permanently delete a specific solution attachment by its unique identifier. Use this action to remove an individual attachment record in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Attachments by id.
/api/objects/v1/SolutionAttachment
Permanently delete multiple solution attachments by their unique identifiers. Use this action to perform bulk removal of solution attachments in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Attachments corresponding to the given data fields.
/api/objects/v1/SolutionAttachment
Retrieve a list of solution attachments that match the criteria specified in the request body. Use this action to search attachments using complex data fields in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Attachments corresponding to the given parameters.
/api/objects/v1/SolutionAttachment
Retrieve a list of solution attachments corresponding to the provided query parameters. Use this action to filter and view attachment records across solutions in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Attachment by id.
/api/objects/v1/SolutionAttachment/{id}
Retrieve the details of a single solution attachment by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Attachment based on the specified view model.
/api/objects/v1/SolutionAttachment/{id}
Update fields of an existing solution attachment by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Attachments based on the specified view models.
/api/objects/v1/SolutionAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionAttachment Member API (9)
GET /prm/api/objects/v1/SolutionAttachment/{id}/_view
/prm/api/objects/v1/SolutionAttachment/{id}/_view
Retrieve the view presentation or metadata for a single solution attachment by its unique identifier for a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Attachments based on the specified view model(s).
/prm/api/objects/v1/SolutionAttachment
Create one or more new solution attachments as a member based on the provided view models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Attachment by id.
/prm/api/objects/v1/SolutionAttachment/{id}
Delete an individual solution attachment by its unique identifier as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Attachments by id.
/prm/api/objects/v1/SolutionAttachment
Delete multiple solution attachments in bulk as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Attachments corresponding to the given data fields.
/prm/api/objects/v1/SolutionAttachment
Search and retrieve solution attachments matching the specified data fields and criteria as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Attachments corresponding to the given parameters.
/prm/api/objects/v1/SolutionAttachment
Retrieve a list of solution attachments filtered by the provided query parameters as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Attachment by id.
/prm/api/objects/v1/SolutionAttachment/{id}
Retrieve the details of a single solution attachment by its unique identifier as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Attachment based on the specified view model.
/prm/api/objects/v1/SolutionAttachment/{id}
Update an existing solution attachment by its unique identifier as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Attachments based on the specified view models.
/prm/api/objects/v1/SolutionAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionEngagement Admin API (8)
PUT Adds a single or many Solution Engagements based on the specified view model(s).
/api/objects/v1/SolutionEngagement
Create one or more solution engagements using administrative privileges based on the provided view models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Engagement by id.
/api/objects/v1/SolutionEngagement/{id}
Delete an individual solution engagement by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Engagements by id.
/api/objects/v1/SolutionEngagement
Delete multiple solution engagements in bulk using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Engagements corresponding to the given data fields.
/api/objects/v1/SolutionEngagement
Search and retrieve solution engagements matching the specified data fields using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Engagements corresponding to the given parameters.
/api/objects/v1/SolutionEngagement
Retrieve a list of solution engagements filtered by query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Engagement by id.
/api/objects/v1/SolutionEngagement/{id}
Retrieve the details of a single solution engagement by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Engagement based on the specified view model.
/api/objects/v1/SolutionEngagement/{id}
Update an existing solution engagement by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Engagements based on the specified view models.
/api/objects/v1/SolutionEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionEngagement Member API (8)
PUT Adds a single or many Solution Engagements based on the specified view model(s).
/prm/api/objects/v1/SolutionEngagement
Create one or more solution engagements as a member based on the provided view models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Engagement by id.
/prm/api/objects/v1/SolutionEngagement/{id}
Delete an individual solution engagement by its unique identifier as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Engagements by id.
/prm/api/objects/v1/SolutionEngagement
Delete multiple solution engagements in bulk as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Engagements corresponding to the given data fields.
/prm/api/objects/v1/SolutionEngagement
Retrieve a list of solution engagements matching criteria specified in the request body. Use this member-level action to query engagements using complex field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Engagements corresponding to the given parameters.
/prm/api/objects/v1/SolutionEngagement
Retrieve a list of solution engagements accessible to the member context based on query parameters. Use this action to search or paginate through engagement records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Engagement by id.
/prm/api/objects/v1/SolutionEngagement/{id}
Retrieve the details of a specific solution engagement by its unique identifier. Use this member-level action to view an individual engagement record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Engagement based on the specified view model.
/prm/api/objects/v1/SolutionEngagement/{id}
Partially update an existing solution engagement using the provided view model. Use this member-level action to modify specific fields of an engagement record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Engagements based on the specified view models.
/prm/api/objects/v1/SolutionEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListing Admin API (10)
PUT /api/objects/v1/SolutionListing/{id}
/api/objects/v1/SolutionListing/{id}
Create or replace a specific solution listing by its unique identifier. Use this administrative action to update or set full listing details for an existing ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
GET /api/objects/v1/SolutionListing/{id}/_view
/api/objects/v1/SolutionListing/{id}/_view
Retrieve the view representation of a specific solution listing by its identifier. Use this administrative action to inspect the formatted or aggregated view model of a listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Listings based on the specified view model(s).
/api/objects/v1/SolutionListing
Create or update one or more solution listings in bulk. Use this administrative action to add or replace multiple listing records simultaneously.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Listing by id.
/api/objects/v1/SolutionListing/{id}
Permanently delete a single solution listing by its unique identifier. Use this administrative action to remove an individual listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Listings by id.
/api/objects/v1/SolutionListing
Permanently delete multiple solution listings identified in the request. Use this administrative action for bulk removal of listing records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Listings corresponding to the given data fields.
/api/objects/v1/SolutionListing
Retrieve a list of solution listings matching criteria defined in the request body. Use this administrative action to query listings with complex search filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Listings corresponding to the given parameters.
/api/objects/v1/SolutionListing
Retrieve a list of solution listings based on provided query parameters. Use this administrative action to search, filter, and paginate through all listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Listing by id.
/api/objects/v1/SolutionListing/{id}
Retrieve the full details of a specific solution listing by its unique identifier. Use this administrative action to fetch an individual listing record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Listing based on the specified view model.
/api/objects/v1/SolutionListing/{id}
Partially update an existing solution listing using the specified view model. Use this administrative action to modify select fields on an individual listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Listings based on the specified view models.
/api/objects/v1/SolutionListing
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListing Member API (10)
PUT /prm/api/objects/v1/SolutionListing/{id}
/prm/api/objects/v1/SolutionListing/{id}
Create or replace a specific solution listing for the authenticated member. Use this action to update all details of a listing under a designated identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
GET /prm/api/objects/v1/SolutionListing/{id}/_view
/prm/api/objects/v1/SolutionListing/{id}/_view
Retrieve the view representation of a specific solution listing in the member context. Use this action to view formatted listing details for a single record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Listings based on the specified view model(s).
/prm/api/objects/v1/SolutionListing
Create or update one or multiple solution listings on behalf of a member. Use this action to batch-create or replace listings with the provided view models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Listing by id.
/prm/api/objects/v1/SolutionListing/{id}
Permanently delete a specific solution listing by its unique identifier. Use this member-level action to remove an individual listing record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Listings by id.
/prm/api/objects/v1/SolutionListing
Permanently delete multiple solution listings in the member context. Use this action to remove several listing records in a single request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Listings corresponding to the given data fields.
/prm/api/objects/v1/SolutionListing
Retrieve a list of solution listings matching the criteria provided in the request body. Use this member-level action to query listings using complex field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Listings corresponding to the given parameters.
/prm/api/objects/v1/SolutionListing
Retrieve a list of solution listings filtered by query parameters. Use this member-level action to browse or search available listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Listing by id.
/prm/api/objects/v1/SolutionListing/{id}
Retrieve details for a specific solution listing by its unique identifier. Use this member-level action to inspect the attributes of a single listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Listing based on the specified view model.
/prm/api/objects/v1/SolutionListing/{id}
Update specific fields of an existing solution listing by its unique identifier. Use this member-level action to make partial updates to listing attributes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Listings based on the specified view models.
/prm/api/objects/v1/SolutionListing
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListingAttachment Admin API (9)
GET /api/objects/v1/SolutionListingAttachment/{id}/_view
/api/objects/v1/SolutionListingAttachment/{id}/_view
Retrieve the view representation for a specific solution listing attachment by its unique identifier. Use this admin action to access attachment view configurations or rendered details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Listing Attachments based on the specified view model(s).
/api/objects/v1/SolutionListingAttachment
Create or replace one or more solution listing attachments. Use this admin action to bulk upload or set up attachments linked to solution listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Listing Attachment by id.
/api/objects/v1/SolutionListingAttachment/{id}
Permanently delete an individual solution listing attachment by its unique identifier. Use this admin action to remove an obsolete or unwanted attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Listing Attachments by id.
/api/objects/v1/SolutionListingAttachment
Permanently delete multiple solution listing attachments. Use this admin action to batch remove attachments from the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Listing Attachments corresponding to the given data fields.
/api/objects/v1/SolutionListingAttachment
Retrieve a list of solution listing attachments matching the criteria defined in the request body. Use this admin action to query attachments using complex field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Listing Attachments corresponding to the given parameters.
/api/objects/v1/SolutionListingAttachment
Retrieve a list of solution listing attachments filtered by query parameters. Use this admin action to search or paginate through listing attachments across the platform.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Listing Attachment by id.
/api/objects/v1/SolutionListingAttachment/{id}
Retrieve details of a single solution listing attachment by its unique identifier. Use this admin action to inspect attachment metadata and settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Listing Attachment based on the specified view model.
/api/objects/v1/SolutionListingAttachment/{id}
Update specific fields of a single solution listing attachment by its unique identifier. Use this admin action to modify attachment metadata or settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Listing Attachments based on the specified view models.
/api/objects/v1/SolutionListingAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListingAttachment Member API (9)
GET /prm/api/objects/v1/SolutionListingAttachment/{id}/_view
/prm/api/objects/v1/SolutionListingAttachment/{id}/_view
Retrieve the view representation for a specific solution listing attachment by its unique identifier. Use this member-level action to display attachment view details to authenticated users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Listing Attachments based on the specified view model(s).
/prm/api/objects/v1/SolutionListingAttachment
Create or replace one or more solution listing attachments. Use this member-level action to upload single or multiple attachments for a solution listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Listing Attachment by id.
/prm/api/objects/v1/SolutionListingAttachment/{id}
Permanently delete a specific solution listing attachment by its unique identifier. Use this member-level action to remove an individual attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Listing Attachments by id.
/prm/api/objects/v1/SolutionListingAttachment
Permanently delete multiple solution listing attachments in a single request. Use this member-level action to batch remove attachments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Listing Attachments corresponding to the given data fields.
/prm/api/objects/v1/SolutionListingAttachment
Retrieve a list of solution listing attachments matching the criteria provided in the request body. Use this member-level action to filter attachments using complex data fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Listing Attachments corresponding to the given parameters.
/prm/api/objects/v1/SolutionListingAttachment
Retrieve a list of solution listing attachments filtered by query parameters. Use this member-level action to browse or search attachments available to the member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Listing Attachment by id.
/prm/api/objects/v1/SolutionListingAttachment/{id}
Retrieve details of a specific solution listing attachment by its unique identifier. Use this member-level action to inspect attachment information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Listing Attachment based on the specified view model.
/prm/api/objects/v1/SolutionListingAttachment/{id}
Update an existing solution listing attachment as a member using the provided ID and view model. Use this to modify attachment details or metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Listing Attachments based on the specified view models.
/prm/api/objects/v1/SolutionListingAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListingCategory Admin API (9)
GET /api/objects/v1/SolutionListingCategory/{id}/_view
/api/objects/v1/SolutionListingCategory/{id}/_view
Retrieve the view representation of a specific solution listing category by its ID. Use this to view detailed category information from an administrative perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Listing Categories based on the specified view model(s).
/api/objects/v1/SolutionListingCategory
Create or update one or multiple solution listing categories using the administrative API. Use this to bulk upsert category definitions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Listing Category by id.
/api/objects/v1/SolutionListingCategory/{id}
Permanently delete a specific solution listing category by its ID using the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Listing Categories by id.
/api/objects/v1/SolutionListingCategory
Permanently delete multiple solution listing categories in bulk using the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Listing Categories corresponding to the given data fields.
/api/objects/v1/SolutionListingCategory
Retrieve a list of solution listing categories filtered by specified data fields in the request body. Use this for advanced administrative category queries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Listing Categories corresponding to the given parameters.
/api/objects/v1/SolutionListingCategory
Retrieve a list of solution listing categories matching query parameters. Use this to browse or search categories administratively.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Listing Category by id.
/api/objects/v1/SolutionListingCategory/{id}
Retrieve the details of a single solution listing category by its ID using the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Listing Category based on the specified view model.
/api/objects/v1/SolutionListingCategory/{id}
Update specific fields of an existing solution listing category by ID using the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Listing Categories based on the specified view models.
/api/objects/v1/SolutionListingCategory
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListingCategory Member API (9)
GET /prm/api/objects/v1/SolutionListingCategory/{id}/_view
/prm/api/objects/v1/SolutionListingCategory/{id}/_view
Retrieve the view representation of a specific solution listing category by its ID from the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Solution Listing Categories based on the specified view model(s).
/prm/api/objects/v1/SolutionListingCategory
Create or update one or more solution listing categories as a member. Use this to upsert category records within member workflows.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Listing Category by id.
/prm/api/objects/v1/SolutionListingCategory/{id}
Permanently delete a specific solution listing category by its ID as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Listing Categories by id.
/prm/api/objects/v1/SolutionListingCategory
Permanently delete multiple solution listing categories in bulk using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Listing Categories corresponding to the given data fields.
/prm/api/objects/v1/SolutionListingCategory
Retrieve a list of solution listing categories corresponding to data fields provided in the request body as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Listing Categories corresponding to the given parameters.
/prm/api/objects/v1/SolutionListingCategory
Retrieve a list of solution listing categories matching query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Listing Category by id.
/prm/api/objects/v1/SolutionListingCategory/{id}
Retrieve the details of a single solution listing category by its ID using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Listing Category based on the specified view model.
/prm/api/objects/v1/SolutionListingCategory/{id}
Update specific fields of an existing solution listing category by ID as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Listing Categories based on the specified view models.
/prm/api/objects/v1/SolutionListingCategory
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListingEngagement Admin API (8)
PUT Adds a single or many Solution Engagements based on the specified view model(s).
/api/objects/v1/SolutionListingEngagement
Create or update one or multiple solution listing engagements using the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Engagement by id.
/api/objects/v1/SolutionListingEngagement/{id}
Permanently delete a specific solution listing engagement by its ID using the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Engagements by id.
/api/objects/v1/SolutionListingEngagement
Permanently delete multiple solution listing engagements in bulk using the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Engagements corresponding to the given data fields.
/api/objects/v1/SolutionListingEngagement
Retrieve a list of solution listing engagements using administrative access by matching criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Engagements corresponding to the given parameters.
/api/objects/v1/SolutionListingEngagement
Retrieve a list of solution listing engagements matching query parameters via the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Engagement by id.
/api/objects/v1/SolutionListingEngagement/{id}
Retrieve the details of a specific solution listing engagement by its unique identifier using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Engagement based on the specified view model.
/api/objects/v1/SolutionListingEngagement/{id}
Update specific fields of an existing solution listing engagement by its identifier using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Engagements based on the specified view models.
/api/objects/v1/SolutionListingEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
SolutionListingEngagement Member API (8)
PUT Adds a single or many Solution Engagements based on the specified view model(s).
/prm/api/objects/v1/SolutionListingEngagement
Create or replace one or more solution listing engagements using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Solution Engagement by id.
/prm/api/objects/v1/SolutionListingEngagement/{id}
Delete a single solution listing engagement by its identifier using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Solution Engagements by id.
/prm/api/objects/v1/SolutionListingEngagement
Delete multiple solution listing engagements by their identifiers using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Solution Engagements corresponding to the given data fields.
/prm/api/objects/v1/SolutionListingEngagement
Retrieve a list of solution listing engagements matching data fields sent in the request body using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solution Engagements corresponding to the given parameters.
/prm/api/objects/v1/SolutionListingEngagement
Retrieve a list of solution listing engagements matching query parameters using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution Engagement by id.
/prm/api/objects/v1/SolutionListingEngagement/{id}
Retrieve the details of a single solution listing engagement by its identifier using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution Engagement based on the specified view model.
/prm/api/objects/v1/SolutionListingEngagement/{id}
Update specific fields of an existing solution listing engagement by its identifier using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solution Engagements based on the specified view models.
/prm/api/objects/v1/SolutionListingEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
StandardFieldPicklist Admin API (3)
POST Gets a list of Standard Picklists corresponding to the given data fields.
/api/objects/v1/StandardFieldPicklist
Retrieve a list of standard field picklists matching the criteria provided in the request body using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Standard Picklists corresponding to the given parameters.
/api/objects/v1/StandardFieldPicklist
Retrieve a list of standard field picklists matching specified query parameters using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Standard Picklist by id.
/api/objects/v1/StandardFieldPicklist/{id}
Retrieve a single standard field picklist by its unique identifier using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
StandardFieldPicklist Member API (3)
POST Gets a list of Standard Picklists corresponding to the given data fields.
/prm/api/objects/v1/StandardFieldPicklist
Retrieve a list of standard field picklists matching the filter fields sent in the request body using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Standard Picklists corresponding to the given parameters.
/prm/api/objects/v1/StandardFieldPicklist
Retrieve a list of standard field picklists matching specified query parameters using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Standard Picklist by id.
/prm/api/objects/v1/StandardFieldPicklist/{id}
Retrieve a single standard field picklist by its identifier using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
StandardFieldPicklistOption Admin API (3)
POST Gets a list of Standard Picklist Options corresponding to the given data fields.
/api/objects/v1/StandardFieldPicklistOption
Retrieve a list of standard picklist options matching specified data field criteria using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Standard Picklist Options corresponding to the given parameters.
/api/objects/v1/StandardFieldPicklistOption
Retrieve a list of standard picklist options matching specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Standard Picklist Option by id.
/api/objects/v1/StandardFieldPicklistOption/{id}
Retrieve details for a specific standard picklist option by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
StandardFieldPicklistOption Member API (3)
POST Gets a list of Standard Picklist Options corresponding to the given data fields.
/prm/api/objects/v1/StandardFieldPicklistOption
Retrieve a list of standard picklist options matching specified data field criteria using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Standard Picklist Options corresponding to the given parameters.
/prm/api/objects/v1/StandardFieldPicklistOption
Retrieve a list of standard picklist options matching specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Standard Picklist Option by id.
/prm/api/objects/v1/StandardFieldPicklistOption/{id}
Retrieve details for a specific standard picklist option by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
State Admin API (4)
GET /api/objects/v1/State/_settings
/api/objects/v1/State/_settings
Retrieve configuration settings for state objects using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of States corresponding to the given data fields.
/api/objects/v1/State
Retrieve a list of states matching specified data field criteria using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of States corresponding to the given parameters.
/api/objects/v1/State
Retrieve a list of states matching specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single State by id.
/api/objects/v1/State/{id}
Retrieve details for a single state by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
State Member API (4)
GET /prm/api/objects/v1/State/_settings
/prm/api/objects/v1/State/_settings
Retrieve configuration settings for state objects using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of States corresponding to the given data fields.
/prm/api/objects/v1/State
Retrieve a list of states matching specified data field criteria using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of States corresponding to the given parameters.
/prm/api/objects/v1/State
Retrieve a list of states matching specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single State by id.
/prm/api/objects/v1/State/{id}
Retrieve details for a single state by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
SupportProgramListing Admin API (3)
POST Gets a list of Support Program Listings corresponding to the given data fields.
/api/objects/v1/SupportProgramListing
Retrieve a list of support program listings matching specified data field criteria using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Support Program Listings corresponding to the given parameters.
/api/objects/v1/SupportProgramListing
Retrieve a list of support program listings matching specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Support Program Listing by id.
/api/objects/v1/SupportProgramListing/{id}
Retrieve details for a single support program listing by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
SupportProgramListing Member API (3)
POST Gets a list of Support Program Listings corresponding to the given data fields.
/prm/api/objects/v1/SupportProgramListing
Retrieve a list of support program listings matching specified criteria provided in the request body for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Support Program Listings corresponding to the given parameters.
/prm/api/objects/v1/SupportProgramListing
Retrieve a list of support program listings using URL query parameters for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Support Program Listing by id.
/prm/api/objects/v1/SupportProgramListing/{id}
Retrieve details of a single support program listing by its unique identifier for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
SupportedLocale Admin API (3)
POST Gets a list of Supported Locales corresponding to the given data fields.
/api/objects/v1/SupportedLocale
Retrieve a list of supported locales matching the criteria supplied in the request body using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Supported Locales corresponding to the given parameters.
/api/objects/v1/SupportedLocale
Retrieve a list of supported locales using URL query parameters with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Supported Locale by id.
/api/objects/v1/SupportedLocale/{id}
Retrieve details of a single supported locale by its unique identifier with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
SupportedLocale Member API (3)
POST Gets a list of Supported Locales corresponding to the given data fields.
/prm/api/objects/v1/SupportedLocale
Retrieve a list of supported locales matching the criteria supplied in the request body for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Supported Locales corresponding to the given parameters.
/prm/api/objects/v1/SupportedLocale
Retrieve a list of supported locales using URL query parameters for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Supported Locale by id.
/prm/api/objects/v1/SupportedLocale/{id}
Retrieve details of a single supported locale by its unique identifier for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Tag Admin API (3)
POST Gets a list of Tags corresponding to the given data fields.
/api/objects/v1/Tag
Retrieve a list of tags matching the criteria supplied in the request body with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tags corresponding to the given parameters.
/api/objects/v1/Tag
Retrieve a list of tags using URL query parameters with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tag by id.
/api/objects/v1/Tag/{id}
Retrieve details of a single tag by its unique identifier with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Tag Member API (3)
POST Gets a list of Tags corresponding to the given data fields.
/prm/api/objects/v1/Tag
Retrieve a list of tags matching the criteria supplied in the request body for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tags corresponding to the given parameters.
/prm/api/objects/v1/Tag
Retrieve a list of tags using URL query parameters for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tag by id.
/prm/api/objects/v1/Tag/{id}
Retrieve details of a single tag by its unique identifier for member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TagLink Admin API (8)
PUT Adds a single or many Tag Links based on the specified view model(s).
/api/objects/v1/TagLink
Create or update one or more tag links based on the provided view models using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tag Link by id.
/api/objects/v1/TagLink/{id}
Delete a single tag link by its unique identifier with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tag Links by id.
/api/objects/v1/TagLink
Delete multiple tag links in bulk by their identifiers with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tag Links corresponding to the given data fields.
/api/objects/v1/TagLink
Retrieve a list of tag links that match the criteria specified in the request body. Use this when query parameters are insufficient for filtering tag link records as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tag Links corresponding to the given parameters.
/api/objects/v1/TagLink
Retrieve a list of tag links matching the specified query parameters. Use this to search or browse tag link records as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tag Link by id.
/api/objects/v1/TagLink/{id}
Retrieve a single tag link by its unique identifier. Use this to view details of a specific tag link as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tag Link based on the specified view model.
/api/objects/v1/TagLink/{id}
Update specific fields of an existing tag link identified by its unique ID. Use this to modify a tag link record via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tag Links based on the specified view models.
/api/objects/v1/TagLink
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TagLink Member API (8)
PUT Adds a single or many Tag Links based on the specified view model(s).
/prm/api/objects/v1/TagLink
Create or replace one or more tag links using the provided view model data. Use this to insert or bulk upsert tag link records as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tag Link by id.
/prm/api/objects/v1/TagLink/{id}
Permanently remove a single tag link by its unique identifier. Use this to delete an unwanted tag link record as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tag Links by id.
/prm/api/objects/v1/TagLink
Permanently remove multiple tag links in a single request. Use this for bulk deletion of tag link records as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tag Links corresponding to the given data fields.
/prm/api/objects/v1/TagLink
Retrieve a list of tag links that match criteria specified in the request body. Use this to search tag link records as a member when complex filtering is required.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tag Links corresponding to the given parameters.
/prm/api/objects/v1/TagLink
Retrieve a list of tag links matching the provided query parameters. Use this to browse or filter tag link records as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tag Link by id.
/prm/api/objects/v1/TagLink/{id}
Retrieve the details of a single tag link by its unique identifier. Use this to inspect a specific tag link record as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tag Link based on the specified view model.
/prm/api/objects/v1/TagLink/{id}
Update fields of an existing tag link identified by its unique ID. Use this to make partial updates to a tag link record as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tag Links based on the specified view models.
/prm/api/objects/v1/TagLink
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TcmaLanguage Admin API (8)
PUT Adds a single or many Tcma Languages based on the specified view model(s).
/api/objects/v1/TcmaLanguage
Create or replace one or more TCMA languages using the provided view model data. Use this to add or bulk upsert language configurations as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tcma Language by id.
/api/objects/v1/TcmaLanguage/{id}
Permanently delete a single TCMA language by its unique identifier. Use this to remove an unneeded language configuration as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tcma Languages by id.
/api/objects/v1/TcmaLanguage
Permanently delete multiple TCMA languages in a single request. Use this to batch remove language configurations as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tcma Languages corresponding to the given data fields.
/api/objects/v1/TcmaLanguage
Retrieve a list of TCMA languages matching the criteria specified in the request body. Use this for complex searches across language records as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tcma Languages corresponding to the given parameters.
/api/objects/v1/TcmaLanguage
Retrieve a list of TCMA languages filtered by the provided query parameters. Use this to view or search available language settings as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tcma Language by id.
/api/objects/v1/TcmaLanguage/{id}
Retrieve a single TCMA language by its unique identifier. Use this to view details of a specific language setting as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tcma Language based on the specified view model.
/api/objects/v1/TcmaLanguage/{id}
Update specific fields of an existing TCMA language by its unique ID. Use this to modify language configuration details as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tcma Languages based on the specified view models.
/api/objects/v1/TcmaLanguage
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TcmaLanguage Member API (8)
PUT Adds a single or many Tcma Languages based on the specified view model(s).
/prm/api/objects/v1/TcmaLanguage
Create or replace one or more TCMA languages based on the provided view models. Use this to add or bulk upsert language records as a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tcma Language by id.
/prm/api/objects/v1/TcmaLanguage/{id}
Delete a single TCMA language record by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tcma Languages by id.
/prm/api/objects/v1/TcmaLanguage
Delete multiple TCMA language records identified by their unique IDs via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tcma Languages corresponding to the given data fields.
/prm/api/objects/v1/TcmaLanguage
Retrieve a list of TCMA language records matching the specified criteria provided in the request body via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tcma Languages corresponding to the given parameters.
/prm/api/objects/v1/TcmaLanguage
Retrieve a list of TCMA language records matching the specified query parameters via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tcma Language by id.
/prm/api/objects/v1/TcmaLanguage/{id}
Retrieve details of a single TCMA language record by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tcma Language based on the specified view model.
/prm/api/objects/v1/TcmaLanguage/{id}
Update specific fields of an existing TCMA language record by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tcma Languages based on the specified view models.
/prm/api/objects/v1/TcmaLanguage
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TcmaSettingField Admin API (8)
PUT Adds a single or many Tcma Setting Fields based on the specified view model(s).
/api/objects/v1/TcmaSettingField
Create or replace one or more TCMA setting field records via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tcma Setting Field by id.
/api/objects/v1/TcmaSettingField/{id}
Delete a single TCMA setting field record by its unique identifier via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tcma Setting Fields by id.
/api/objects/v1/TcmaSettingField
Delete multiple TCMA setting field records identified by their unique IDs via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tcma Setting Fields corresponding to the given data fields.
/api/objects/v1/TcmaSettingField
Retrieve a list of TCMA setting field records matching the criteria provided in the request body via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tcma Setting Fields corresponding to the given parameters.
/api/objects/v1/TcmaSettingField
Retrieve a list of TCMA setting field records matching the specified query parameters via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tcma Setting Field by id.
/api/objects/v1/TcmaSettingField/{id}
Retrieve details of a single TCMA setting field record by its unique identifier via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tcma Setting Field based on the specified view model.
/api/objects/v1/TcmaSettingField/{id}
Update specific fields of an existing TCMA setting field record by its unique identifier via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tcma Setting Fields based on the specified view models.
/api/objects/v1/TcmaSettingField
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TcmaSettingField Member API (8)
PUT Adds a single or many Tcma Setting Fields based on the specified view model(s).
/prm/api/objects/v1/TcmaSettingField
Create or replace one or more TCMA setting field records via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tcma Setting Field by id.
/prm/api/objects/v1/TcmaSettingField/{id}
Delete a single TCMA setting field record by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tcma Setting Fields by id.
/prm/api/objects/v1/TcmaSettingField
Delete multiple TCMA setting field records identified by their unique IDs via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tcma Setting Fields corresponding to the given data fields.
/prm/api/objects/v1/TcmaSettingField
Retrieve a list of TCMA setting field records matching the criteria provided in the request body via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tcma Setting Fields corresponding to the given parameters.
/prm/api/objects/v1/TcmaSettingField
Retrieve a list of TCMA setting field records matching the specified query parameters via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tcma Setting Field by id.
/prm/api/objects/v1/TcmaSettingField/{id}
Retrieve details of a single TCMA setting field record by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tcma Setting Field based on the specified view model.
/prm/api/objects/v1/TcmaSettingField/{id}
Update specific fields of an existing TCMA setting field record by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tcma Setting Fields based on the specified view models.
/prm/api/objects/v1/TcmaSettingField
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TcmaSettingTab Admin API (8)
PUT Adds a single or many Tcma Setting Tabs based on the specified view model(s).
/api/objects/v1/TcmaSettingTab
Create one or more TCMA setting tabs using administrative privileges. Use this action to provision new configuration tab records in bulk or individually.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tcma Setting Tab by id.
/api/objects/v1/TcmaSettingTab/{id}
Permanently remove a single TCMA setting tab by its identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tcma Setting Tabs by id.
/api/objects/v1/TcmaSettingTab
Delete multiple TCMA setting tabs simultaneously by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tcma Setting Tabs corresponding to the given data fields.
/api/objects/v1/TcmaSettingTab
Query and retrieve TCMA setting tabs matching specified payload criteria using administrative privileges. Use this action when complex filtering criteria must be submitted in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tcma Setting Tabs corresponding to the given parameters.
/api/objects/v1/TcmaSettingTab
Retrieve a list of TCMA setting tabs based on URL query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tcma Setting Tab by id.
/api/objects/v1/TcmaSettingTab/{id}
Retrieve details for a specific TCMA setting tab by its identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tcma Setting Tab based on the specified view model.
/api/objects/v1/TcmaSettingTab/{id}
Update specific fields of an existing TCMA setting tab by its identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tcma Setting Tabs based on the specified view models.
/api/objects/v1/TcmaSettingTab
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TcmaSettingTab Member API (8)
PUT Adds a single or many Tcma Setting Tabs based on the specified view model(s).
/prm/api/objects/v1/TcmaSettingTab
Create one or more TCMA setting tabs using member-level access. Use this action to add configuration tabs within the context of a member account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Tcma Setting Tab by id.
/prm/api/objects/v1/TcmaSettingTab/{id}
Permanently remove a single TCMA setting tab by its identifier using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Tcma Setting Tabs by id.
/prm/api/objects/v1/TcmaSettingTab
Delete multiple TCMA setting tabs simultaneously by their identifiers using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Tcma Setting Tabs corresponding to the given data fields.
/prm/api/objects/v1/TcmaSettingTab
Query and retrieve TCMA setting tabs matching payload criteria using member-level access. Use this action when submitting complex search filters in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tcma Setting Tabs corresponding to the given parameters.
/prm/api/objects/v1/TcmaSettingTab
Retrieve a list of TCMA setting tabs based on URL query parameters using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tcma Setting Tab by id.
/prm/api/objects/v1/TcmaSettingTab/{id}
Retrieve details for a specific TCMA setting tab by its identifier using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Tcma Setting Tab based on the specified view model.
/prm/api/objects/v1/TcmaSettingTab/{id}
Update specific fields of an existing TCMA setting tab by its identifier using member-level access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Tcma Setting Tabs based on the specified view models.
/prm/api/objects/v1/TcmaSettingTab
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TcmaShowcaseTranslation Admin API
POST /api/objects/v1/TcmaShowcaseTranslation/clone
/api/objects/v1/TcmaShowcaseTranslation/clone
Clone showcase translations from one language to another using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the source language to copy translations from. |
|
|
The unique identifier of the target language to receive the copied translations. |
Test_Course__co Admin API (11)
PUT Adds a single or many Test Courses based on the specified view model(s).
/api/objects/v1/Test_Course__co
Create one or more custom test course records using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Test Course by id.
/api/objects/v1/Test_Course__co/{id}
Permanently remove a single custom test course record by its identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Test Courses by id.
/api/objects/v1/Test_Course__co
Delete multiple custom test course records simultaneously by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Test Courses based on the given data fields.
/api/objects/v1/Test_Course__co/_export
Export Test Course records via the Admin API based on specified field criteria in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Test Courses based on the same get parameters.
/api/objects/v1/Test_Course__co/_export
Export Test Course records via the Admin API using query parameters to filter results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Test Courses corresponding to the given data fields.
/api/objects/v1/Test_Course__co
Retrieve a list of Test Course records via the Admin API matching criteria specified in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Test Courses corresponding to the given parameters.
/api/objects/v1/Test_Course__co
Retrieve a list of Test Course records via the Admin API matching the specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Test Course by id.
/api/objects/v1/Test_Course__co/{id}
Retrieve details for a single Test Course record by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for Test Course.
/api/objects/v1/Test_Course__co/_export/types
Retrieve the supported export formats and types for Test Course records via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Test Course based on the specified view model.
/api/objects/v1/Test_Course__co/{id}
Update the fields of a specific Test Course record by its identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Test Courses based on the specified view models.
/api/objects/v1/Test_Course__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Test_Course__co Member API (11)
PUT Adds a single or many Test Courses based on the specified view model(s).
/prm/api/objects/v1/Test_Course__co
Create or replace one or more Test Course records using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Test Course by id.
/prm/api/objects/v1/Test_Course__co/{id}
Permanently delete a specific Test Course record by its identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Test Courses by id.
/prm/api/objects/v1/Test_Course__co
Permanently delete multiple Test Course records by their identifiers using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Test Courses based on the given data fields.
/prm/api/objects/v1/Test_Course__co/_export
Export Test Course records via the Member API based on field filters supplied in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Test Courses based on the same get parameters.
/prm/api/objects/v1/Test_Course__co/_export
Export Test Course records via the Member API using query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Test Courses corresponding to the given data fields.
/prm/api/objects/v1/Test_Course__co
Retrieve a list of Test Course records via the Member API matching criteria specified in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Test Courses corresponding to the given parameters.
/prm/api/objects/v1/Test_Course__co
Retrieve a list of Test Course records via the Member API matching the specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Test Course by id.
/prm/api/objects/v1/Test_Course__co/{id}
Retrieve details for a single Test Course record by its unique identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for Test Course.
/prm/api/objects/v1/Test_Course__co/_export/types
Retrieve the supported export formats and types for Test Course records via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Test Course based on the specified view model.
/prm/api/objects/v1/Test_Course__co/{id}
Update the fields of a specific Test Course record by its identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Test Courses based on the specified view models.
/prm/api/objects/v1/Test_Course__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
TextCobrandArea Admin API (3)
POST Gets a list of Co-branding Template Text Area corresponding to the given data fields.
/api/objects/v1/TextCobrandArea
Query for a list of co-branding template text areas matching specific data fields using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Co-branding Template Text Area corresponding to the given parameters.
/api/objects/v1/TextCobrandArea
Retrieve a list of co-branding template text areas matching query parameters using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Co-branding Template Text Area by id.
/api/objects/v1/TextCobrandArea/{id}
Retrieve a specific co-branding template text area by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TextCobrandArea Member API (3)
POST Gets a list of Co-branding Template Text Area corresponding to the given data fields.
/prm/api/objects/v1/TextCobrandArea
Query for a list of co-branding template text areas matching specific data fields using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Co-branding Template Text Area corresponding to the given parameters.
/prm/api/objects/v1/TextCobrandArea
Retrieve a list of co-branding template text areas matching query parameters using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Co-branding Template Text Area by id.
/prm/api/objects/v1/TextCobrandArea/{id}
Retrieve a specific co-branding template text area by its unique identifier using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Tier Admin API (3)
POST Gets a list of Tiers corresponding to the given data fields.
/api/objects/v1/Tier
Query for a list of tiers matching specified data fields using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tiers corresponding to the given parameters.
/api/objects/v1/Tier
Retrieve a list of tiers matching query parameters using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tier by id.
/api/objects/v1/Tier/{id}
Retrieve a specific tier by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Tier Member API (3)
POST Gets a list of Tiers corresponding to the given data fields.
/prm/api/objects/v1/Tier
Query for a list of tiers matching specified data fields using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Tiers corresponding to the given parameters.
/prm/api/objects/v1/Tier
Retrieve a list of tiers matching query parameters using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Tier by id.
/prm/api/objects/v1/Tier/{id}
Retrieve a specific tier by its unique identifier using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TierGroup Admin API (3)
POST Gets a list of TierGroups corresponding to the given data fields.
/api/objects/v1/TierGroup
Query for a list of tier groups matching specified data fields using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of TierGroups corresponding to the given parameters.
/api/objects/v1/TierGroup
Retrieve a list of tier groups matching query parameters using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single TierGroup by id.
/api/objects/v1/TierGroup/{id}
Retrieve a specific tier group by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TierGroup Member API (3)
POST Gets a list of TierGroups corresponding to the given data fields.
/prm/api/objects/v1/TierGroup
Query for a list of tier groups matching specified data fields using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of TierGroups corresponding to the given parameters.
/prm/api/objects/v1/TierGroup
Retrieve a list of tier groups matching query parameters using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single TierGroup by id.
/prm/api/objects/v1/TierGroup/{id}
Retrieve a single tier group record by its unique identifier. Use this to inspect the details and configuration of a specific tier group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreement Admin API (5)
GET Get all pending agreements for the account
/api/objects/v1/TosAgreement/_pendingAccountAgreements
Retrieve all pending terms of service agreements for the current account. Use this to determine which agreements require account-level review or approval.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
what account to get the agreements of |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Agreements corresponding to the given data fields.
/api/objects/v1/TosAgreement
Search and retrieve a list of terms of service agreements matching specified data fields. Use this administrative action when complex query criteria need to be submitted in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreements corresponding to the given parameters.
/api/objects/v1/TosAgreement
Retrieve a list of terms of service agreements filtered by query parameters. Use this administrative action to look up agreements across the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement by id.
/api/objects/v1/TosAgreement/{id}
Retrieve a single terms of service agreement by its unique identifier. Use this administrative action to view detailed agreement content and metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Same as _pendingAgreements endpoint except for admins so a user can be specified. Useful for seeing if any are blocking
/api/objects/v1/TosAgreement/_pendingAgreementsOfPartner
Retrieve pending agreements for a specified partner user as an administrator. Use this to check whether any outstanding terms of service agreements are currently blocking the user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
what user to get the agreements of |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreement Member API (8)
POST Accept Agreement
/prm/api/objects/v1/TosAgreement/{id}/_accept
Record the acceptance of a terms of service agreement on behalf of the current member. Use this when a user consents to the agreement terms.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the specific agreement version being accepted. |
|
|
The language or regional locale code corresponding to the version being accepted. |
POST Dismiss Agreement
/prm/api/objects/v1/TosAgreement/{id}/_dismiss
Dismiss a terms of service agreement for the current member. Use this to record that a user has declined or closed the agreement prompt without accepting.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the account to view. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the specific agreement version being dismissed. |
|
|
The language or regional locale code corresponding to the version being dismissed. |
GET Get all agreements that apply to the current partner user, sorted by pending status (pending agreements first, then accepted ones) and acceptance date (only accepted agreements)
/prm/api/objects/v1/TosAgreement/_userAcceptanceStates
Retrieve all agreements applicable to the current partner user, ordered by pending status followed by acceptance date. Use this to view a comprehensive history of the user's agreement states.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
optional agreement type filter of "User" or "Account" |
|
|
The response format expected from the API (e.g. application/json). |
GET Get all pending agreements that apply to the current partner user
/prm/api/objects/v1/TosAgreement/_pendingAgreements
Retrieve all pending terms of service agreements that apply to the current partner user. Use this to present required agreements that still await user action.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get general status of pending agreements for partner user
/prm/api/objects/v1/TosAgreement/_pendingStatus
Retrieve the general status of pending agreements for the current partner user. Use this to quickly verify whether any unresolved agreements exist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Agreements corresponding to the given data fields.
/prm/api/objects/v1/TosAgreement
Search and retrieve a list of terms of service agreements matching the provided data fields from the member portal. Use this when filtering agreements using request body criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreements corresponding to the given parameters.
/prm/api/objects/v1/TosAgreement
Retrieve a list of terms of service agreements filtered by query parameters from the member portal. Use this to browse accessible agreements.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement by id.
/prm/api/objects/v1/TosAgreement/{id}
Retrieve a single terms of service agreement by its unique identifier from the member portal. Use this to display agreement details to a partner user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreementAcceptance Admin API (3)
POST Gets a list of Agreement Acceptances corresponding to the given data fields.
/api/objects/v1/TosAgreementAcceptance
Search and retrieve agreement acceptance records matching the provided data fields. Use this administrative action to look up acceptance logs using request body criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreement Acceptances corresponding to the given parameters.
/api/objects/v1/TosAgreementAcceptance
Retrieve a list of agreement acceptance records filtered by query parameters. Use this administrative action to audit agreement acceptances across the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement Acceptance by id.
/api/objects/v1/TosAgreementAcceptance/{id}
Retrieve a single agreement acceptance record by its unique identifier. Use this administrative action to inspect the details of an individual acceptance event.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreementAcceptance Member API (3)
POST Gets a list of Agreement Acceptances corresponding to the given data fields.
/prm/api/objects/v1/TosAgreementAcceptance
Search and retrieve agreement acceptance records matching the provided data fields from the member portal. Use this to query the current member's acceptance records using request body criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreement Acceptances corresponding to the given parameters.
/prm/api/objects/v1/TosAgreementAcceptance
Retrieve a list of agreement acceptance records matching query parameters from the member portal. Use this to review agreement acceptances associated with the member account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement Acceptance by id.
/prm/api/objects/v1/TosAgreementAcceptance/{id}
Retrieve a single agreement acceptance record by its unique identifier from the member portal. Use this to view details of a specific acceptance record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreementAcceptanceAttachment Admin API (3)
POST Gets a list of Agreement Acceptance Attachments corresponding to the given data fields.
/api/objects/v1/TosAgreementAcceptanceAttachment
Retrieve a list of Terms of Service agreement acceptance attachments matching the provided data fields using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreement Acceptance Attachments corresponding to the given parameters.
/api/objects/v1/TosAgreementAcceptanceAttachment
Retrieve a list of Terms of Service agreement acceptance attachments based on query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement Acceptance Attachment by id.
/api/objects/v1/TosAgreementAcceptanceAttachment/{id}
Retrieve a single Terms of Service agreement acceptance attachment by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreementAcceptanceAttachment Member API (3)
POST Gets a list of Agreement Acceptance Attachments corresponding to the given data fields.
/prm/api/objects/v1/TosAgreementAcceptanceAttachment
Retrieve a list of Terms of Service agreement acceptance attachments matching the provided data fields from the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreement Acceptance Attachments corresponding to the given parameters.
/prm/api/objects/v1/TosAgreementAcceptanceAttachment
Retrieve a list of Terms of Service agreement acceptance attachments using query parameters from the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement Acceptance Attachment by id.
/prm/api/objects/v1/TosAgreementAcceptanceAttachment/{id}
Retrieve a single Terms of Service agreement acceptance attachment by its unique identifier from the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreementVersion Admin API (3)
POST Gets a list of Agreement Versions corresponding to the given data fields.
/api/objects/v1/TosAgreementVersion
Retrieve a list of Terms of Service agreement versions matching the specified data fields using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreement Versions corresponding to the given parameters.
/api/objects/v1/TosAgreementVersion
Retrieve a list of Terms of Service agreement versions matching the specified query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement Version by id.
/api/objects/v1/TosAgreementVersion/{id}
Retrieve a single Terms of Service agreement version by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
TosAgreementVersion Member API (3)
POST Gets a list of Agreement Versions corresponding to the given data fields.
/prm/api/objects/v1/TosAgreementVersion
Retrieve a list of Terms of Service agreement versions matching the provided data fields from the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Agreement Versions corresponding to the given parameters.
/prm/api/objects/v1/TosAgreementVersion
Retrieve a list of Terms of Service agreement versions matching the specified query parameters from the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Agreement Version by id.
/prm/api/objects/v1/TosAgreementVersion/{id}
Retrieve a single Terms of Service agreement version by its unique identifier from the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
User Admin API (22)
PUT Adds a single or many Users based on the specified view model(s).
/api/objects/v1/Member
Create or update one or more members using the provided view models via the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
PUT Adds a single or many Users based on the specified view model(s).
/api/objects/v1/User
Create or update one or more users using the provided view models via the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single User by id.
/api/objects/v1/Member/{id}
Permanently delete a single member record by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes a single User by id.
/api/objects/v1/User/{id}
Permanently delete a single user record by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Users by id.
/api/objects/v1/Member
Permanently delete multiple member records by their identifiers in a single administrative operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
DELETE Deletes many Users by id.
/api/objects/v1/User
Permanently delete multiple user records by their identifiers in a single administrative operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Users based on the given data fields.
/api/objects/v1/Member/_export
Export member user records based on the criteria specified in the request body. Use this action to generate data exports with complex field configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
POST Exports the Users based on the given data fields.
/api/objects/v1/User/_export
Export user records based on the criteria provided in the request body. Use this action to retrieve exported user data using specific data field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Users based on the same get parameters.
/api/objects/v1/Member/_export
Export member user records using standard query parameters. Use this action to download member data filtered by specified URL parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
GET Exports the Users based on the same get parameters.
/api/objects/v1/User/_export
Export user records using standard query parameters. Use this action to request a file export of users matching the provided query values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Users corresponding to the given data fields.
/api/objects/v1/Member
Retrieve a list of member users that match criteria provided in the request body. Use this action when querying for members with complex filter rules.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
POST Gets a list of Users corresponding to the given data fields.
/api/objects/v1/User
Retrieve a list of users corresponding to criteria defined in the request body. Use this action to search for users using advanced field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Users corresponding to the given parameters.
/api/objects/v1/Member
Retrieve a list of member users filtered by query parameters. Use this action for standard lookups and paginated browsing of member records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a list of Users corresponding to the given parameters.
/api/objects/v1/User
Retrieve a list of users filtered by query parameters. Use this action for standard queries and listing existing users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User by id.
/api/objects/v1/Member/{id}
Retrieve details for a single member user by their unique identifier. Use this action to inspect a specific member profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User by id.
/api/objects/v1/User/{id}
Retrieve details for a single user by their unique identifier. Use this action to look up specific user profile information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for User.
/api/objects/v1/Member/_export/types
Retrieve the supported export file types and formats available for member users. Use this action before initiating a member export to discover supported options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for User.
/api/objects/v1/User/_export/types
Retrieve the supported export formats and types available for users. Use this action prior to generating user exports to inspect valid options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User based on the specified view model.
/api/objects/v1/Member/{id}
Update specific fields of an existing member user record by ID. Use this action to modify member properties without replacing the entire record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User based on the specified view model.
/api/objects/v1/User/{id}
Update specific fields of an existing user record by ID. Use this action to apply partial changes to a user profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Users based on the specified view models.
/api/objects/v1/Member
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
PATCH Updates many Users based on the specified view models.
/api/objects/v1/User
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
User Member API (22)
PUT Adds a single or many Users based on the specified view model(s).
/prm/api/objects/v1/Member
Create or replace one or more member user records. Use this action to batch import or register new members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
PUT Adds a single or many Users based on the specified view model(s).
/prm/api/objects/v1/User
Create or replace one or more user records. Use this action to provision new users or overwrite existing user entries in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single User by id.
/prm/api/objects/v1/Member/{id}
Permanently remove a single member user record by ID. Use this action to delete a member profile from the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes a single User by id.
/prm/api/objects/v1/User/{id}
Permanently delete a single user record by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Users by id.
/prm/api/objects/v1/Member
Permanently delete multiple member records in bulk by their unique identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
DELETE Deletes many Users by id.
/prm/api/objects/v1/User
Permanently delete multiple user records in bulk by their unique identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Users based on the given data fields.
/prm/api/objects/v1/Member/_export
Export member records based on the data fields and filter criteria specified in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
POST Exports the Users based on the given data fields.
/prm/api/objects/v1/User/_export
Export user records based on the data fields and filter criteria specified in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Users based on the same get parameters.
/prm/api/objects/v1/Member/_export
Export member records matching the provided query filter parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
GET Exports the Users based on the same get parameters.
/prm/api/objects/v1/User/_export
Export user records matching the provided query filter parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Users corresponding to the given data fields.
/prm/api/objects/v1/Member
Retrieve a list of member records matching the criteria and data fields supplied in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
POST Gets a list of Users corresponding to the given data fields.
/prm/api/objects/v1/User
Retrieve a list of user records matching the criteria and data fields supplied in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Users corresponding to the given parameters.
/prm/api/objects/v1/Member
Retrieve a list of member records matching the specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a list of Users corresponding to the given parameters.
/prm/api/objects/v1/User
Retrieve a list of user records matching the specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User by id.
/prm/api/objects/v1/Member/{id}
Retrieve details for a single member record by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User by id.
/prm/api/objects/v1/User/{id}
Retrieve details for a single user record by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for User.
/prm/api/objects/v1/Member/_export/types
Retrieve the supported export formats and types available for member records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for User.
/prm/api/objects/v1/User/_export/types
Retrieve the supported export formats and types available for user records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User based on the specified view model.
/prm/api/objects/v1/Member/{id}
Update specific fields of an existing member record based on the specified view model.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User based on the specified view model.
/prm/api/objects/v1/User/{id}
Update specific fields of an existing user record based on the specified view model.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Users based on the specified view models.
/prm/api/objects/v1/Member
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
PATCH Updates many Users based on the specified view models.
/prm/api/objects/v1/User
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
UserAttachment Admin API (11)
PUT Adds a single or many User Attachments based on the specified view model(s).
/api/objects/v1/UserAttachment
Create or update one or more user attachments as an administrator using the provided view models. Use this action to bulk provision or replace attachment records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single User Attachment by id.
/api/objects/v1/UserAttachment/{id}
Permanently remove a single user attachment by its unique identifier as an administrator. Use this action when an individual attachment is obsolete or uploaded in error.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many User Attachments by id.
/api/objects/v1/UserAttachment
Permanently remove multiple user attachments in a single request by their IDs as an administrator. Use this action to batch cleanup attachment records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the User Attachments based on the given data fields.
/api/objects/v1/UserAttachment/_export
Export user attachment records that match criteria specified in the request payload as an administrator. Use this action when filtering parameters require complex criteria or large field payloads.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the User Attachments based on the same get parameters.
/api/objects/v1/UserAttachment/_export
Export user attachment records that match the query parameters as an administrator. Use this action to generate data exports based on standard URL filter criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of User Attachments corresponding to the given data fields.
/api/objects/v1/UserAttachment
Search and retrieve a collection of user attachments using complex filter criteria submitted in the request body as an administrator. Use this action when search parameters exceed standard query string limitations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Attachments corresponding to the given parameters.
/api/objects/v1/UserAttachment
Retrieve a list of user attachments filtered by standard query parameters as an administrator. Use this action to browse or paginate through attachment records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Attachment by id.
/api/objects/v1/UserAttachment/{id}
Retrieve the details and metadata of a specific user attachment by its identifier as an administrator. Use this action to view individual attachment information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for User Attachment.
/api/objects/v1/UserAttachment/_export/types
Retrieve the supported file formats and export types for user attachments as an administrator. Use this action to verify supported export options before initiating an export.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User Attachment based on the specified view model.
/api/objects/v1/UserAttachment/{id}
Update specific fields of an existing user attachment by its identifier as an administrator. Use this action to modify attachment metadata without replacing the entire record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many User Attachments based on the specified view models.
/api/objects/v1/UserAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
UserAttachment Member API (11)
PUT Adds a single or many User Attachments based on the specified view model(s).
/prm/api/objects/v1/UserAttachment
Create or update one or more user attachments through the member portal using the provided view models. Use this action when managing attachments on behalf of a portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single User Attachment by id.
/prm/api/objects/v1/UserAttachment/{id}
Delete a single user attachment by its identifier through the member portal. Use this action to remove an individual attachment within a member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many User Attachments by id.
/prm/api/objects/v1/UserAttachment
Delete multiple user attachments simultaneously by their IDs through the member portal. Use this action to bulk remove attachments associated with portal members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the User Attachments based on the given data fields.
/prm/api/objects/v1/UserAttachment/_export
Export user attachment records matching criteria provided in the request body through the member portal. Use this action when complex filtering is required for member-level exports.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the User Attachments based on the same get parameters.
/prm/api/objects/v1/UserAttachment/_export
Export user attachment records matching query parameters through the member portal. Use this action to generate attachment exports using standard URL filters for portal members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of User Attachments corresponding to the given data fields.
/prm/api/objects/v1/UserAttachment
Search and retrieve a list of user attachments based on fields submitted in the request body through the member portal. Use this action when query parameters require a structured body payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Attachments corresponding to the given parameters.
/prm/api/objects/v1/UserAttachment
Retrieve a list of user attachments matching query parameters through the member portal. Use this action to browse and paginate through member-accessible attachments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Attachment by id.
/prm/api/objects/v1/UserAttachment/{id}
Retrieve the details and metadata of a single user attachment by its identifier through the member portal. Use this action to view an individual attachment record accessible to the member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for User Attachment.
/prm/api/objects/v1/UserAttachment/_export/types
Retrieve the export types available for user attachments. Use this action to determine supported export formats for member user attachments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User Attachment based on the specified view model.
/prm/api/objects/v1/UserAttachment/{id}
Update specified fields of an existing user attachment by its unique identifier. Use this action to modify member user attachment data without replacing the entire record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many User Attachments based on the specified view models.
/prm/api/objects/v1/UserAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
UserFieldSegment Admin API (3)
POST Gets a list of User Segmentations corresponding to the given data fields.
/api/objects/v1/UserFieldSegment
Search and retrieve user field segmentations based on criteria provided in the request body. Use this administrative action to query segment records matching specific field values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Segmentations corresponding to the given parameters.
/api/objects/v1/UserFieldSegment
Retrieve a list of user field segmentations matching query parameters. Use this administrative action to view configured user segment definitions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Segmentation by id.
/api/objects/v1/UserFieldSegment/{id}
Retrieve details of a single user field segmentation by its unique identifier. Use this administrative action to inspect a specific user segment configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
UserFieldSegment Member API (3)
POST Gets a list of User Segmentations corresponding to the given data fields.
/prm/api/objects/v1/UserFieldSegment
Search and retrieve user field segmentations accessible in the member context based on criteria in the request body. Use this action to query segment definitions matching specific field values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Segmentations corresponding to the given parameters.
/prm/api/objects/v1/UserFieldSegment
Retrieve a list of user field segmentations in the member context matching query parameters. Use this action to view user segment definitions available to members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Segmentation by id.
/prm/api/objects/v1/UserFieldSegment/{id}
Retrieve details of a single user field segmentation by its unique identifier in the member context. Use this action to look up a member-accessible segment record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
UserFilterSegment Admin API (3)
POST Gets a list of User Segmentation (Filter) corresponding to the given data fields.
/api/objects/v1/UserFilterSegment
Search and retrieve user filter segmentations based on criteria provided in the request body. Use this administrative action to filter and find specific user filter segment records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Segmentation (Filter) corresponding to the given parameters.
/api/objects/v1/UserFilterSegment
Retrieve a list of user filter segmentations matching query parameters. Use this administrative action to view configured filter-based user segmentations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Segmentation (Filter) by id.
/api/objects/v1/UserFilterSegment/{id}
Retrieve details of a single user filter segmentation by its unique identifier. Use this administrative action to inspect a specific filter segment configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
UserFilterSegment Member API (3)
POST Gets a list of User Segmentation (Filter) corresponding to the given data fields.
/prm/api/objects/v1/UserFilterSegment
Search and retrieve user filter segmentations in the member context based on criteria provided in the request body. Use this action to find member-accessible filter segments matching specific fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Segmentation (Filter) corresponding to the given parameters.
/prm/api/objects/v1/UserFilterSegment
Retrieve a list of user filter segmentations accessible in the member context matching query parameters. Use this action to view available filter-based user segmentations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Segmentation (Filter) by id.
/prm/api/objects/v1/UserFilterSegment/{id}
Retrieve details of a single user filter segmentation by its unique identifier in the member context. Use this action to look up a member-accessible filter segment record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
UserFilterSegmentGroup Admin API (3)
POST Gets a list of User Segmentation (Group) corresponding to the given data fields.
/api/objects/v1/UserFilterSegmentGroup
Search and retrieve user filter segment groups based on criteria provided in the request body. Use this administrative action to query segment groups matching specific data fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Segmentation (Group) corresponding to the given parameters.
/api/objects/v1/UserFilterSegmentGroup
Retrieve a list of user filter segment groups matching query parameters. Use this administrative action to view configured segmentation groups.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Segmentation (Group) by id.
/api/objects/v1/UserFilterSegmentGroup/{id}
Retrieve details of a single user filter segment group by its unique identifier. Use this administrative action to inspect a specific segment group configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
UserFilterSegmentGroup Member API (3)
POST Gets a list of User Segmentation (Group) corresponding to the given data fields.
/prm/api/objects/v1/UserFilterSegmentGroup
Retrieve a list of user segmentation groups matching the criteria supplied in the request body. Use this action to query member segment groups based on specific data field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Segmentation (Group) corresponding to the given parameters.
/prm/api/objects/v1/UserFilterSegmentGroup
Retrieve a list of user segmentation groups matching the provided query parameters. Use this action to browse or filter member segment groups.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Segmentation (Group) by id.
/prm/api/objects/v1/UserFilterSegmentGroup/{id}
Retrieve the details of a single user segmentation group by its unique identifier. Use this action to view configuration and member details for a specific group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
VendorPartnerNotes Admin API (4)
DELETE Deletes a single Vendor Partner Note by id.
/api/objects/v1/VendorPartnerNotes/{id}
Permanently delete an individual vendor partner note by its unique identifier. Use this action to remove an obsolete or erroneous administrative note.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Vendor Partner Notes by id.
/api/objects/v1/VendorPartnerNotes
Permanently delete multiple vendor partner notes in bulk by their identifiers. Use this action when cleaning up or removing administrative notes in batches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Vendor Partner Note based on the specified view model.
/api/objects/v1/VendorPartnerNotes/{id}
Partially update the specified fields of an existing administrative vendor partner note by its unique identifier. Use this action to modify note content or metadata without replacing the entire record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Vendor Partner Notes based on the specified view models.
/api/objects/v1/VendorPartnerNotes
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
VendorPartnerNotes Member API (4)
DELETE Deletes a single Vendor Partner Note by id.
/prm/api/objects/v1/VendorPartnerNotes/{id}
Permanently delete a single vendor partner note by its identifier using member permissions. Use this action when a member user needs to remove a specific partner note.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Vendor Partner Notes by id.
/prm/api/objects/v1/VendorPartnerNotes
Permanently delete multiple vendor partner notes in bulk using member permissions. Use this action to remove a set of member partner notes simultaneously.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Vendor Partner Note based on the specified view model.
/prm/api/objects/v1/VendorPartnerNotes/{id}
Partially update the contents or attributes of an existing vendor partner note by its identifier using member permissions. Use this action to modify member note details according to the provided view model.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Vendor Partner Notes based on the specified view models.
/prm/api/objects/v1/VendorPartnerNotes
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |