Version 1.0
Connector Overview: This page documents all 650 actions for the Impartnerconnector v1.0.
Account Admin API (13)
GET /api/objects/v1/Account/_match
/api/objects/v1/Account/_match
Search for matching accounts using company name or email criteria through the Admin API. Use this to identify duplicate or existing accounts before performing updates.
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 company name to match against existing accounts. |
|
|
The email address to match against existing accounts. |
|
|
A comma-separated list of field names to include in the response. |
|
|
The maximum number of matching account records to return. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/Account/{id}/_view
/api/objects/v1/Account/{id}/_view
Retrieve a specific account view by account ID through the Admin API. Use this to display or process account details defined in a pre-configured view layout.
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 view. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Accounts based on the specified view model(s).
/api/objects/v1/Account
Create one or more accounts based on specified view models through the Admin API. Use this to provision new account 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 Account by id.
/api/objects/v1/Account/{id}
Permanently remove a single account by its identifier using the Admin API. Use this when offboarding an account or removing an obsolete 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 Accounts by id.
/api/objects/v1/Account
Permanently delete multiple accounts by their identifiers in a single request via the Admin API. Use this for batch cleanups and bulk offboarding.
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 Accounts based on the given data fields.
/api/objects/v1/Account/_export
Initiate an account export file with customized filters, fields, and output format via the Admin API. Use this to generate reports or prepare account data for external systems.
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 restrict which accounts are exported. |
|
|
The identifier of the view definition that determines which accounts and columns to export. |
|
|
The list of specific account fields to include in the export. |
|
|
The search string used to filter accounts matching the text. |
|
|
The number of records to bypass before starting to export results. |
|
|
The maximum number of account records to include in the export. |
GET Exports the Accounts based on the same get parameters.
/api/objects/v1/Account/_export
Download or trigger an export of account records using default or query-based parameters via the Admin API. Use this to retrieve accounts in an exportable file format.
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 Accounts corresponding to the given data fields.
/api/objects/v1/Account
Retrieve a filtered and paginated list of accounts using criteria submitted in the request body via the Admin API. Use this when complex query filters exceed standard query string limits.
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 Accounts corresponding to the given parameters.
/api/objects/v1/Account
Retrieve a list of accounts through the Admin API. Use this to browse or sync active accounts in your organization.
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 Account by id.
/api/objects/v1/Account/{id}
Retrieve the full details of a specific account using its unique identifier via the Admin API. Use this to inspect single account attributes.
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 Account.
/api/objects/v1/Account/_export/types
Retrieve all supported export formats for account data via the Admin API. Use this to inspect available file types before generating 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 Account based on the specified view model.
/api/objects/v1/Account/{id}
Partially update an existing account by its identifier using the Admin API. Use this to modify specific account fields without resubmitting 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 Accounts based on the specified view models.
/api/objects/v1/Account
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. |
Account Member API (13)
GET /prm/api/objects/v1/Account/_match
/prm/api/objects/v1/Account/_match
Search for matching accounts using company name or email criteria through the Member API. Use this to identify existing accounts accessible to member 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 company name to match against member-accessible accounts. |
|
|
The email address to match against member-accessible accounts. |
|
|
A comma-separated list of field names to include in the response. |
|
|
The maximum number of matched member account records to return. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/Account/{id}/_view
/prm/api/objects/v1/Account/{id}/_view
Retrieve a specific account view layout by account ID through the Member API. Use this to fetch account data formatted for partner and member views.
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 Accounts based on the specified view model(s).
/prm/api/objects/v1/Account
Create one or more accounts based on specified view models through the Member API. Use this when partner or member users need to register new accounts.
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 Account by id.
/prm/api/objects/v1/Account/{id}
Delete a single account by ID through the Member API. Use this to remove an account within the authenticated member's 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Accounts by id.
/prm/api/objects/v1/Account
Delete multiple accounts by their IDs through the Member API. Use this to perform batch deletion of accounts within member access limits.
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 Accounts based on the given data fields.
/prm/api/objects/v1/Account/_export
Export accounts based on 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 (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 Accounts based on the same get parameters.
/prm/api/objects/v1/Account/_export
Export accounts using query parameters to filter the exported 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 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 Accounts corresponding to the given data fields.
/prm/api/objects/v1/Account
Retrieve a list of accounts matching the filter criteria defined 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 Accounts corresponding to the given parameters.
/prm/api/objects/v1/Account
Retrieve a list of accounts filtered by 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 Account by id.
/prm/api/objects/v1/Account/{id}
Retrieve the details of a specific account using 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 Account.
/prm/api/objects/v1/Account/_export/types
Retrieve the available export file types and formats supported for accounts.
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 Account based on the specified view model.
/prm/api/objects/v1/Account/{id}
Update specific fields of an existing account identified by its unique 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. |
|
|
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 Accounts based on the specified view models.
/prm/api/objects/v1/Account
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. |
AccountAttachment Admin API (11)
PUT Adds a single or many Account Attachments based on the specified view model(s).
/api/objects/v1/AccountAttachment
Create or replace one or more account attachments using the provided data.
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 Account Attachment by id.
/api/objects/v1/AccountAttachment/{id}
Permanently delete a single account attachment 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 Account Attachments by id.
/api/objects/v1/AccountAttachment
Permanently delete multiple account attachments 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 Exports the Account Attachments based on the given data fields.
/api/objects/v1/AccountAttachment/_export
Export account attachments matching the criteria defined 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 Account Attachments based on the same get parameters.
/api/objects/v1/AccountAttachment/_export
Export account attachments based on 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 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 Account Attachments corresponding to the given data fields.
/api/objects/v1/AccountAttachment
Retrieve a list of account attachments matching the 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 (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 Account Attachments corresponding to the given parameters.
/api/objects/v1/AccountAttachment
Retrieve a list of account attachments 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 Account Attachment by id.
/api/objects/v1/AccountAttachment/{id}
Retrieve the details of a specific account attachment using 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 Account Attachment.
/api/objects/v1/AccountAttachment/_export/types
Retrieve the available export file types and formats supported for account 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 Account Attachment based on the specified view model.
/api/objects/v1/AccountAttachment/{id}
Update specific fields of an existing account attachment by its unique 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. |
|
|
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 Account Attachments based on the specified view models.
/api/objects/v1/AccountAttachment
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. |
AccountAttachment Member API (11)
PUT Adds a single or many Account Attachments based on the specified view model(s).
/prm/api/objects/v1/AccountAttachment
Create one or more account attachments in the partner portal using the provided view model data.
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 Account Attachment by id.
/prm/api/objects/v1/AccountAttachment/{id}
Permanently remove a specific account attachment 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 Account Attachments by id.
/prm/api/objects/v1/AccountAttachment
Delete multiple account attachments simultaneously by providing 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 Exports the Account Attachments based on the given data fields.
/prm/api/objects/v1/AccountAttachment/_export
Export account attachment records that match 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 Account Attachments based on the same get parameters.
/prm/api/objects/v1/AccountAttachment/_export
Export account attachment records filtered by 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 Account Attachments corresponding to the given data fields.
/prm/api/objects/v1/AccountAttachment
Retrieve a list of account attachments matching search criteria defined 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 Account Attachments corresponding to the given parameters.
/prm/api/objects/v1/AccountAttachment
Retrieve a list of account attachments filtered by URL 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 Account Attachment by id.
/prm/api/objects/v1/AccountAttachment/{id}
Retrieve the details of a single account attachment 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 Account Attachment.
/prm/api/objects/v1/AccountAttachment/_export/types
Retrieve the available export file types and formats supported for account 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 Account Attachment based on the specified view model.
/prm/api/objects/v1/AccountAttachment/{id}
Update specific fields of an existing account attachment identified by its 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. |
|
|
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 Account Attachments based on the specified view models.
/prm/api/objects/v1/AccountAttachment
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. |
AccountEngagement Admin API (8)
PUT Adds a single or many Account Engagements based on the specified view model(s).
/api/objects/v1/AccountEngagement
Create one or multiple account engagement records via the administrative interface using 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 Account Engagement by id.
/api/objects/v1/AccountEngagement/{id}
Permanently remove a single account engagement record by its administrative 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 Account Engagements by id.
/api/objects/v1/AccountEngagement
Delete multiple account engagement records at once using their administrative 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 Account Engagements corresponding to the given data fields.
/api/objects/v1/AccountEngagement
Retrieve administrative account engagement records matching the field 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 Account Engagements corresponding to the given parameters.
/api/objects/v1/AccountEngagement
Retrieve a list of administrative account engagement records filtered by 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 Account Engagement by id.
/api/objects/v1/AccountEngagement/{id}
Retrieve the details of a specific administrative account engagement record by its ID.
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 Account Engagement based on the specified view model.
/api/objects/v1/AccountEngagement/{id}
Update selected fields of an existing administrative account engagement record by its 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. |
|
|
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 Account Engagements based on the specified view models.
/api/objects/v1/AccountEngagement
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. |
AccountEngagement Member API (8)
PUT Adds a single or many Account Engagements based on the specified view model(s).
/prm/api/objects/v1/AccountEngagement
Create one or multiple account engagement records via the partner portal using 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 Account Engagement by id.
/prm/api/objects/v1/AccountEngagement/{id}
Permanently remove a single partner portal account engagement 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 Account Engagements by id.
/prm/api/objects/v1/AccountEngagement
Delete multiple account engagement records simultaneously by 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 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 Account Engagements corresponding to the given data fields.
/prm/api/objects/v1/AccountEngagement
Search and retrieve a list of account engagements matching specified field 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 Account Engagements corresponding to the given parameters.
/prm/api/objects/v1/AccountEngagement
Retrieve a list of account engagements 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 Account Engagement by id.
/prm/api/objects/v1/AccountEngagement/{id}
Retrieve the details of a single account engagement 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). |
PATCH Updates a single Account Engagement based on the specified view model.
/prm/api/objects/v1/AccountEngagement/{id}
Update specified fields of an existing account engagement using its unique 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. |
|
|
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 Account Engagements based on the specified view models.
/prm/api/objects/v1/AccountEngagement
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. |
AccountFieldSegment Admin API (3)
POST Gets a list of Account Segmentations corresponding to the given data fields.
/api/objects/v1/AccountFieldSegment
Retrieve account field segmentations matching the data criteria provided in the request body for administrative use.
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 Account Segmentations corresponding to the given parameters.
/api/objects/v1/AccountFieldSegment
Retrieve a list of account field segmentations matching the specified query parameters for administrative use.
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 Account Segmentation by id.
/api/objects/v1/AccountFieldSegment/{id}
Retrieve the details of a specific account field segmentation by its unique identifier for administrative use.
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). |
AccountFieldSegment Member API (3)
POST Gets a list of Account Segmentations corresponding to the given data fields.
/prm/api/objects/v1/AccountFieldSegment
Retrieve account field segmentations matching the data criteria provided in the request body for member 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 Account Segmentations corresponding to the given parameters.
/prm/api/objects/v1/AccountFieldSegment
Retrieve a list of account field segmentations matching the specified query parameters for member 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 Account Segmentation by id.
/prm/api/objects/v1/AccountFieldSegment/{id}
Retrieve the details of a specific account field segmentation by its unique identifier for member 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). |
AccountFilterSegment Admin API (3)
POST Gets a list of Account Segmentation (Filter) corresponding to the given data fields.
/api/objects/v1/AccountFilterSegment
Retrieve account filter segmentations matching the data criteria provided in the request body for administrative use.
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 Account Segmentation (Filter) corresponding to the given parameters.
/api/objects/v1/AccountFilterSegment
Retrieve a list of account filter segmentations matching the specified query parameters for administrative use.
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 Account Segmentation (Filter) by id.
/api/objects/v1/AccountFilterSegment/{id}
Retrieve the details of a specific account filter segmentation by its unique identifier for administrative use.
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). |
AccountFilterSegment Member API (3)
POST Gets a list of Account Segmentation (Filter) corresponding to the given data fields.
/prm/api/objects/v1/AccountFilterSegment
Retrieve account filter segmentations matching the data criteria provided in the request body for member 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 Account Segmentation (Filter) corresponding to the given parameters.
/prm/api/objects/v1/AccountFilterSegment
Retrieve a list of account filter segmentations matching the specified query parameters for member 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 Account Segmentation (Filter) by id.
/prm/api/objects/v1/AccountFilterSegment/{id}
Retrieve the details of a specific account filter segmentation by its unique identifier for member 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). |
AccountFilterSegmentGroup Admin API (3)
POST Gets a list of Account Segmentation (Group) corresponding to the given data fields.
/api/objects/v1/AccountFilterSegmentGroup
Retrieve a list of account segmentation groups matching criteria specified 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 Account Segmentation (Group) corresponding to the given parameters.
/api/objects/v1/AccountFilterSegmentGroup
Retrieve a list of account segmentation groups matching 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 Account Segmentation (Group) by id.
/api/objects/v1/AccountFilterSegmentGroup/{id}
Retrieve details of a specific account segmentation group 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). |
AccountFilterSegmentGroup Member API (3)
POST Gets a list of Account Segmentation (Group) corresponding to the given data fields.
/prm/api/objects/v1/AccountFilterSegmentGroup
Retrieve a list of account segmentation groups matching criteria specified 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 Account Segmentation (Group) corresponding to the given parameters.
/prm/api/objects/v1/AccountFilterSegmentGroup
Retrieve a list of account segmentation groups 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 Account Segmentation (Group) by id.
/prm/api/objects/v1/AccountFilterSegmentGroup/{id}
Retrieve details of a specific account segmentation group by its unique 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). |
AccountListing Admin API (13)
PUT /api/objects/v1/AccountListing/{id}
/api/objects/v1/AccountListing/{id}
Create or completely replace an account listing record identified by its ID 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 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/AccountListing/{id}/_view
/api/objects/v1/AccountListing/{id}/_view
Retrieve the view representation for a specific account listing 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. |
|
|
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 Account Listings based on the specified view model(s).
/api/objects/v1/AccountListing
Create or update one or more account listings 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 Account Listing by id.
/api/objects/v1/AccountListing/{id}
Permanently delete a single account listing 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 Account Listings by id.
/api/objects/v1/AccountListing
Delete multiple account listings identified by their IDs 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 Exports the Account Listings based on the given data fields.
/api/objects/v1/AccountListing/_export
Export account listings matching the filter criteria provided 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 (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 Account Listings based on the same get parameters.
/api/objects/v1/AccountListing/_export
Export account listings 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 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 Account Listings corresponding to the given data fields.
/api/objects/v1/AccountListing
Search and retrieve a list of account listings based on criteria specified 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 Account Listings corresponding to the given parameters.
/api/objects/v1/AccountListing
Retrieve a list of account listings 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 Account Listing by id.
/api/objects/v1/AccountListing/{id}
Retrieve details of a single account listing 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). |
GET Gets the Export types available for Account Listing.
/api/objects/v1/AccountListing/_export/types
Retrieve the list of available export formats supported for account listings 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. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Account Listing based on the specified view model.
/api/objects/v1/AccountListing/{id}
Partially update an existing account listing by its ID using the specified view model 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. |
|
|
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 Account Listings based on the specified view models.
/api/objects/v1/AccountListing
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. |
AccountListing Member API (13)
PUT /prm/api/objects/v1/AccountListing/{id}
/prm/api/objects/v1/AccountListing/{id}
Create or completely replace an account listing record identified by its unique 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/AccountListing/{id}/_view
/prm/api/objects/v1/AccountListing/{id}/_view
Retrieve the view representation of a specific account listing 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. |
|
|
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 Account Listings based on the specified view model(s).
/prm/api/objects/v1/AccountListing
Add one or more account listings using the provided view model 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 Account Listing by id.
/prm/api/objects/v1/AccountListing/{id}
Permanently remove a single account listing 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 Account Listings by id.
/prm/api/objects/v1/AccountListing
Delete multiple account listings in bulk 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 Exports the Account Listings based on the given data fields.
/prm/api/objects/v1/AccountListing/_export
Export account listings using the specified data fields and filtering criteria 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 Account Listings based on the same get parameters.
/prm/api/objects/v1/AccountListing/_export
Export account listings based on the provided 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 Account Listings corresponding to the given data fields.
/prm/api/objects/v1/AccountListing
Retrieve a list of account listings matching the data fields and 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 (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 Account Listings corresponding to the given parameters.
/prm/api/objects/v1/AccountListing
Retrieve a list of account listings filtered by the provided 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 Account Listing by id.
/prm/api/objects/v1/AccountListing/{id}
Retrieve the details of a single account listing 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 Account Listing.
/prm/api/objects/v1/AccountListing/_export/types
Retrieve the list of supported export file formats and types available for account 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. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Account Listing based on the specified view model.
/prm/api/objects/v1/AccountListing/{id}
Partially update specific fields of an existing account listing identified by its unique 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. |
|
|
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 Account Listings based on the specified view models.
/prm/api/objects/v1/AccountListing
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. |
AccountListingAttachment Admin API (12)
GET /api/objects/v1/AccountListingAttachment/{id}/_view
/api/objects/v1/AccountListingAttachment/{id}/_view
Retrieve the view representation of an account listing attachment 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. |
|
|
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 Account Listing Attachments based on the specified view model(s).
/api/objects/v1/AccountListingAttachment
Add one or more account listing attachments using the provided view model 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 Account Listing Attachment by id.
/api/objects/v1/AccountListingAttachment/{id}
Permanently delete a specific account listing attachment 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 Account Listing Attachments by id.
/api/objects/v1/AccountListingAttachment
Delete multiple account listing attachments in bulk 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 Exports the Account Listing Attachments based on the given data fields.
/api/objects/v1/AccountListingAttachment/_export
Export account listing attachments based on criteria and fields 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 (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 Account Listing Attachments based on the same get parameters.
/api/objects/v1/AccountListingAttachment/_export
Export account listing attachments 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 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 Account Listing Attachments corresponding to the given data fields.
/api/objects/v1/AccountListingAttachment
Retrieve a list of account listing attachments matching the specified request payload criteria 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 Account Listing Attachments corresponding to the given parameters.
/api/objects/v1/AccountListingAttachment
Retrieve a list of account listing attachments filtered by 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 Account Listing Attachment by id.
/api/objects/v1/AccountListingAttachment/{id}
Retrieve details for a specific account listing attachment by its 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). |
GET Gets the Export types available for Account Listing Attachment.
/api/objects/v1/AccountListingAttachment/_export/types
Retrieve the available export file formats and types for account listing attachments 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 Account Listing Attachment based on the specified view model.
/api/objects/v1/AccountListingAttachment/{id}
Update fields of an existing account listing attachment by its identifier using the provided view model 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 Account Listing Attachments based on the specified view models.
/api/objects/v1/AccountListingAttachment
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. |
AccountListingAttachment Member API (12)
GET /prm/api/objects/v1/AccountListingAttachment/{id}/_view
/prm/api/objects/v1/AccountListingAttachment/{id}/_view
Retrieve the view representation for a specific account listing attachment by its 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. |
|
|
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 Account Listing Attachments based on the specified view model(s).
/prm/api/objects/v1/AccountListingAttachment
Create one or multiple account listing attachments based on the provided view models 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 Account Listing Attachment by id.
/prm/api/objects/v1/AccountListingAttachment/{id}
Permanently delete a specific account listing attachment by its 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 Account Listing Attachments by id.
/prm/api/objects/v1/AccountListingAttachment
Permanently delete multiple account listing attachments by their identifiers 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 Exports the Account Listing Attachments based on the given data fields.
/prm/api/objects/v1/AccountListingAttachment/_export
Export account listing attachments that match the criteria specified 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 (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 Account Listing Attachments based on the same get parameters.
/prm/api/objects/v1/AccountListingAttachment/_export
Export account listing attachments based on 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 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 Account Listing Attachments corresponding to the given data fields.
/prm/api/objects/v1/AccountListingAttachment
Retrieve a list of account listing attachments matching the specified request payload criteria 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 Account Listing Attachments corresponding to the given parameters.
/prm/api/objects/v1/AccountListingAttachment
Retrieve a list of account listing attachments filtered by 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 Account Listing Attachment by id.
/prm/api/objects/v1/AccountListingAttachment/{id}
Retrieve details for a specific account listing attachment by its 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). |
GET Gets the Export types available for Account Listing Attachment.
/prm/api/objects/v1/AccountListingAttachment/_export/types
Retrieve the available export file formats and types for account listing attachments 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 Account Listing Attachment based on the specified view model.
/prm/api/objects/v1/AccountListingAttachment/{id}
Update fields of an existing account listing attachment by its identifier using the provided view model 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 Account Listing Attachments based on the specified view models.
/prm/api/objects/v1/AccountListingAttachment
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. |
AccountListingCategory Admin API (12)
GET /api/objects/v1/AccountListingCategory/{id}/_view
/api/objects/v1/AccountListingCategory/{id}/_view
Retrieve the view representation for a specific account listing category by its 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. |
|
|
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 Account Listing Categories based on the specified view model(s).
/api/objects/v1/AccountListingCategory
Create one or multiple account listing categories based on the provided view models 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 Account Listing Category by id.
/api/objects/v1/AccountListingCategory/{id}
Permanently delete a specific account listing category by its 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 Account Listing Categories by id.
/api/objects/v1/AccountListingCategory
Delete multiple account listing categories simultaneously by their IDs 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Account Listing Categories based on the given data fields.
/api/objects/v1/AccountListingCategory/_export
Export account listing categories using filter criteria and fields defined 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 (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 Account Listing Categories based on the same get parameters.
/api/objects/v1/AccountListingCategory/_export
Export account listing categories matching 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 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 Account Listing Categories corresponding to the given data fields.
/api/objects/v1/AccountListingCategory
Retrieve a list of account listing categories based on search criteria and field filters submitted 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 Account Listing Categories corresponding to the given parameters.
/api/objects/v1/AccountListingCategory
Retrieve a list of account listing categories matching 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 Account Listing Category by id.
/api/objects/v1/AccountListingCategory/{id}
Retrieve details of a single account listing category 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). |
GET Gets the Export types available for Account Listing Category.
/api/objects/v1/AccountListingCategory/_export/types
Retrieve the supported export formats and types available for account listing categories 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 Account Listing Category based on the specified view model.
/api/objects/v1/AccountListingCategory/{id}
Update specific fields of an existing account listing category by its ID 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 Account Listing Categories based on the specified view models.
/api/objects/v1/AccountListingCategory
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. |
AccountListingCategory Member API (12)
GET /prm/api/objects/v1/AccountListingCategory/{id}/_view
/prm/api/objects/v1/AccountListingCategory/{id}/_view
Retrieve the member view representation for a specific account listing category by its ID 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 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 Account Listing Categories based on the specified view model(s).
/prm/api/objects/v1/AccountListingCategory
Create or update one or more account listing categories 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 Account Listing Category by id.
/prm/api/objects/v1/AccountListingCategory/{id}
Delete a single account listing category 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 Account Listing Categories by id.
/prm/api/objects/v1/AccountListingCategory
Delete multiple account listing categories simultaneously by their IDs 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 Account Listing Categories based on the given data fields.
/prm/api/objects/v1/AccountListingCategory/_export
Export account listing categories based on criteria specified 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 (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 Account Listing Categories based on the same get parameters.
/prm/api/objects/v1/AccountListingCategory/_export
Export account listing categories matching 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 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 Account Listing Categories corresponding to the given data fields.
/prm/api/objects/v1/AccountListingCategory
Retrieve a list of account listing categories based on filter 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 Account Listing Categories corresponding to the given parameters.
/prm/api/objects/v1/AccountListingCategory
Retrieve a list of account listing categories 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 Account Listing Category by id.
/prm/api/objects/v1/AccountListingCategory/{id}
Retrieve details of a single account listing category 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). |
GET Gets the Export types available for Account Listing Category.
/prm/api/objects/v1/AccountListingCategory/_export/types
Retrieve the available export file types for Account Listing Categories via the member API. Use this to determine valid export formats 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 Account Listing Category based on the specified view model.
/prm/api/objects/v1/AccountListingCategory/{id}
Update specific fields of an existing Account Listing Category 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 Account Listing Categories based on the specified view models.
/prm/api/objects/v1/AccountListingCategory
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. |
AccountSnapshot Admin API (8)
PUT Adds a single or many Account Snapshots based on the specified view model(s).
/api/objects/v1/AccountSnapshot
Create or update one or more Account Snapshots using the administrator 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 Account Snapshot by id.
/api/objects/v1/AccountSnapshot/{id}
Permanently delete a specific Account Snapshot by its unique identifier using the administrator 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 Account Snapshots by id.
/api/objects/v1/AccountSnapshot
Permanently delete multiple Account Snapshots in bulk using the administrator 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 Account Snapshots corresponding to the given data fields.
/api/objects/v1/AccountSnapshot
Query and retrieve a list of Account Snapshots matching the field criteria provided in the request body via the administrator 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 Account Snapshots corresponding to the given parameters.
/api/objects/v1/AccountSnapshot
Retrieve a list of Account Snapshots matching the specified query parameters via the administrator 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 Account Snapshot by id.
/api/objects/v1/AccountSnapshot/{id}
Retrieve details of a single Account Snapshot by its unique identifier using the administrator 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 Account Snapshot based on the specified view model.
/api/objects/v1/AccountSnapshot/{id}
Update specific fields of an existing Account Snapshot by its unique identifier using the administrator 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 Account Snapshots based on the specified view models.
/api/objects/v1/AccountSnapshot
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. |
AccountSnapshot Member API (8)
PUT Adds a single or many Account Snapshots based on the specified view model(s).
/prm/api/objects/v1/AccountSnapshot
Create or update one or more Account Snapshots 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 Account Snapshot by id.
/prm/api/objects/v1/AccountSnapshot/{id}
Permanently delete a specific Account Snapshot 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Account Snapshots by id.
/prm/api/objects/v1/AccountSnapshot
Permanently delete multiple Account Snapshots 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 Account Snapshots corresponding to the given data fields.
/prm/api/objects/v1/AccountSnapshot
Query and retrieve a list of Account Snapshots matching the field 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 Account Snapshots corresponding to the given parameters.
/prm/api/objects/v1/AccountSnapshot
Retrieve a list of Account Snapshots 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 Account Snapshot by id.
/prm/api/objects/v1/AccountSnapshot/{id}
Retrieve details of a single Account Snapshot 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). |
PATCH Updates a single Account Snapshot based on the specified view model.
/prm/api/objects/v1/AccountSnapshot/{id}
Update specific fields of an existing Account Snapshot by its unique 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 Account Snapshots based on the specified view models.
/prm/api/objects/v1/AccountSnapshot
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. |
AccountTierHistory Admin API (8)
PUT Adds a single or many Account Tier Histories based on the specified view model(s).
/api/objects/v1/AccountTierHistory
Create or update one or more Account Tier History records using the administrator 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 Account Tier History by id.
/api/objects/v1/AccountTierHistory/{id}
Permanently delete a single Account Tier History record by its unique identifier using the administrator 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 Account Tier Histories by id.
/api/objects/v1/AccountTierHistory
Permanently delete multiple Account Tier History records in bulk using the administrator 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 Account Tier Histories corresponding to the given data fields.
/api/objects/v1/AccountTierHistory
Retrieve a list of account tier history records matching criteria specified 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 Account Tier Histories corresponding to the given parameters.
/api/objects/v1/AccountTierHistory
Retrieve a list of account tier history records 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 Account Tier History by id.
/api/objects/v1/AccountTierHistory/{id}
Retrieve a specific account tier history 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 |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Account Tier History based on the specified view model.
/api/objects/v1/AccountTierHistory/{id}
Update specific fields of an existing account tier history record 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 Account Tier Histories based on the specified view models.
/api/objects/v1/AccountTierHistory
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. |
AccountTierHistory Member API (8)
PUT Adds a single or many Account Tier Histories based on the specified view model(s).
/prm/api/objects/v1/AccountTierHistory
Create or replace one or multiple account tier history records 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 Account Tier History by id.
/prm/api/objects/v1/AccountTierHistory/{id}
Permanently delete a specific account tier history record 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 Account Tier Histories by id.
/prm/api/objects/v1/AccountTierHistory
Permanently delete multiple account tier history records 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 Account Tier Histories corresponding to the given data fields.
/prm/api/objects/v1/AccountTierHistory
Retrieve a list of account tier history records matching criteria specified 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 Account Tier Histories corresponding to the given parameters.
/prm/api/objects/v1/AccountTierHistory
Retrieve a list of account tier history records filtered by 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 Account Tier History by id.
/prm/api/objects/v1/AccountTierHistory/{id}
Retrieve a specific account tier history record 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 Account Tier History based on the specified view model.
/prm/api/objects/v1/AccountTierHistory/{id}
Update specific fields of an existing account tier history record 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 Account Tier Histories based on the specified view models.
/prm/api/objects/v1/AccountTierHistory
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. |
ActiveTierRequirements Admin API (8)
PUT Adds a single or many Active Tier Requirements based on the specified view model(s).
/api/objects/v1/ActiveTierRequirements
Create or replace one or multiple active tier requirement 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 Active Tier Requirement by id.
/api/objects/v1/ActiveTierRequirements/{id}
Permanently delete a specific active tier requirement 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 Active Tier Requirements by id.
/api/objects/v1/ActiveTierRequirements
Permanently delete multiple active tier requirement records 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 Active Tier Requirements corresponding to the given data fields.
/api/objects/v1/ActiveTierRequirements
Retrieve a list of active tier requirements matching criteria specified 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 Active Tier Requirements corresponding to the given parameters.
/api/objects/v1/ActiveTierRequirements
Retrieve a list of active tier requirements 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 Active Tier Requirement by id.
/api/objects/v1/ActiveTierRequirements/{id}
Retrieve a single active tier requirement 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 |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Active Tier Requirement based on the specified view model.
/api/objects/v1/ActiveTierRequirements/{id}
Update specific fields of an existing active tier requirement record 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 Active Tier Requirements based on the specified view models.
/api/objects/v1/ActiveTierRequirements
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. |
ActiveTierRequirements Member API (8)
PUT Adds a single or many Active Tier Requirements based on the specified view model(s).
/prm/api/objects/v1/ActiveTierRequirements
Create or replace one or multiple active tier requirement records 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 Active Tier Requirement by id.
/prm/api/objects/v1/ActiveTierRequirements/{id}
Permanently delete an active tier requirement 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 Active Tier Requirements by id.
/prm/api/objects/v1/ActiveTierRequirements
Permanently delete multiple active tier requirements 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 Active Tier Requirements corresponding to the given data fields.
/prm/api/objects/v1/ActiveTierRequirements
Retrieve active tier requirements matching the filter 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 Active Tier Requirements corresponding to the given parameters.
/prm/api/objects/v1/ActiveTierRequirements
Retrieve a list of active tier requirements filtered by 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 Active Tier Requirement by id.
/prm/api/objects/v1/ActiveTierRequirements/{id}
Retrieve the details of a specific active tier requirement 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). |
PATCH Updates a single Active Tier Requirement based on the specified view model.
/prm/api/objects/v1/ActiveTierRequirements/{id}
Apply partial updates to an active tier requirement by its unique identifier using 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 Active Tier Requirements based on the specified view models.
/prm/api/objects/v1/ActiveTierRequirements
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. |
Administrator Admin API (4)
GET /api/objects/v1/administrator/_getLogins
/api/objects/v1/administrator/_getLogins
Retrieve login details and session information for administrators.
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 Administrators corresponding to the given data fields.
/api/objects/v1/Administrator
Search and retrieve administrators matching 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 (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 Administrators corresponding to the given parameters.
/api/objects/v1/Administrator
Retrieve a list of administrators based on 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 Administrator by id.
/api/objects/v1/Administrator/{id}
Retrieve details of a single administrator by their 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). |
Administrator Member API (3)
POST Gets a list of Administrators corresponding to the given data fields.
/prm/api/objects/v1/Administrator
Search and retrieve member-accessible administrator records 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 Administrators corresponding to the given parameters.
/prm/api/objects/v1/Administrator
Retrieve a list of member-accessible administrator records matching 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 Administrator by id.
/prm/api/objects/v1/Administrator/{id}
Retrieve details of a single member-accessible administrator 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). |
AdministratorRolePermission Admin API (3)
POST Gets a list of Administrator Role Permissions corresponding to the given data fields.
/api/objects/v1/AdministratorRolePermission
Search and retrieve administrator role permissions matching 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 (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 Administrator Role Permissions corresponding to the given parameters.
/api/objects/v1/AdministratorRolePermission
Retrieve a list of administrator role permissions based on 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 Administrator Role Permission by id.
/api/objects/v1/AdministratorRolePermission/{id}
Retrieve details of a specific administrator role permission 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). |
AdministratorRolePermission Member API (3)
POST Gets a list of Administrator Role Permissions corresponding to the given data fields.
/prm/api/objects/v1/AdministratorRolePermission
Search and retrieve member-accessible administrator role permissions matching criteria 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 Administrator Role Permissions corresponding to the given parameters.
/prm/api/objects/v1/AdministratorRolePermission
Retrieve a list of member-accessible administrator role permissions filtered by 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 Administrator Role Permission by id.
/prm/api/objects/v1/AdministratorRolePermission/{id}
Retrieve details of a single administrator role permission by its unique identifier. Use this to verify or audit specific access permissions assigned to admin roles.
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). |
AppUser Admin API (4)
DELETE Deletes a single Application User by id.
/api/objects/v1/AppUser/{id}
Permanently delete an application user by their 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 Application Users by id.
/api/objects/v1/AppUser
Delete multiple application users 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 list of account IDs to delete. |
PATCH Updates a single Application User based on the specified view model.
/api/objects/v1/AppUser/{id}
Update specific fields of an existing application user by their unique 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. |
|
|
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 Application Users based on the specified view models.
/api/objects/v1/AppUser
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. |
AppUser Member API (4)
DELETE Deletes a single Application User by id.
/prm/api/objects/v1/AppUser/{id}
Delete a single application user by their unique identifier via member 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Application Users by id.
/prm/api/objects/v1/AppUser
Delete multiple application users in bulk via member 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Application User based on the specified view model.
/prm/api/objects/v1/AppUser/{id}
Update specific fields of an existing application user via member 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. |
|
|
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 Application Users based on the specified view models.
/prm/api/objects/v1/AppUser
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. |
Applicant Admin API (12)
POST /api/objects/v1/Applicant/{id}/_approve
/api/objects/v1/Applicant/{id}/_approve
Approve a specific applicant record by its unique identifier. Use this to advance partner applicants through your onboarding workflow.
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. |
|
|
Specifies the status to assign to the applicant upon approval. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Applicants based on the specified view model(s).
/api/objects/v1/Applicant
Create or replace one or multiple applicant records 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 Applicant by id.
/api/objects/v1/Applicant/{id}
Permanently delete an applicant by their 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 Applicants by id.
/api/objects/v1/Applicant
Delete multiple applicants 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 list of account IDs to delete. |
POST Exports the Applicants based on the given data fields.
/api/objects/v1/Applicant/_export
Export applicant records based on the criteria and data fields 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 Applicants based on the same get parameters.
/api/objects/v1/Applicant/_export
Export applicant records using filter criteria provided via 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 Applicants corresponding to the given data fields.
/api/objects/v1/Applicant
Retrieve a list of applicants matching the complex query filters 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 Applicants corresponding to the given parameters.
/api/objects/v1/Applicant
Retrieve a list of applicants matching the provided 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 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 Applicant by id.
/api/objects/v1/Applicant/{id}
Retrieve the details of a single applicant by their 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 Applicant.
/api/objects/v1/Applicant/_export/types
Retrieve the list of file export formats available for applicant data.
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 Applicant based on the specified view model.
/api/objects/v1/Applicant/{id}
Update specific fields of an existing applicant by their unique 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. |
|
|
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 Applicants based on the specified view models.
/api/objects/v1/Applicant
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. |
Applicant Member API (12)
POST /prm/api/objects/v1/Applicant/{id}/_approve
/prm/api/objects/v1/Applicant/{id}/_approve
Approve a specific applicant record by its unique identifier via member 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. |
|
|
The unique identifier of the account to view. |
|
|
Specifies the status to assign to the applicant upon approval. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Applicants based on the specified view model(s).
/prm/api/objects/v1/Applicant
Create one or multiple applicant records based on the specified view model data.
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 Applicant by id.
/prm/api/objects/v1/Applicant/{id}
Permanently remove a single applicant record using 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 Applicants by id.
/prm/api/objects/v1/Applicant
Permanently remove multiple applicant records using 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 Applicants based on the given data fields.
/prm/api/objects/v1/Applicant/_export
Export applicant data matching the criteria and fields 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 Applicants based on the same get parameters.
/prm/api/objects/v1/Applicant/_export
Export applicant data matching the supplied 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 Applicants corresponding to the given data fields.
/prm/api/objects/v1/Applicant
Retrieve a list of applicant records matching the search 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 Applicants corresponding to the given parameters.
/prm/api/objects/v1/Applicant
Retrieve a list of applicant 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 Applicant by id.
/prm/api/objects/v1/Applicant/{id}
Retrieve details for a single applicant record using 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 Applicant.
/prm/api/objects/v1/Applicant/_export/types
Retrieve the available export file formats and types for applicant data.
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 Applicant based on the specified view model.
/prm/api/objects/v1/Applicant/{id}
Update specific fields of an existing applicant record by its unique 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. |
|
|
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 Applicants based on the specified view models.
/prm/api/objects/v1/Applicant
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. |
ApplicantApprovalStatus Admin API (3)
POST Gets a list of Applicant Approval Status corresponding to the given data fields.
/api/objects/v1/ApplicantApprovalStatus
Retrieve a list of applicant approval statuses matching the 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 Applicant Approval Status corresponding to the given parameters.
/api/objects/v1/ApplicantApprovalStatus
Retrieve a list of applicant approval statuses 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 Applicant Approval Status by id.
/api/objects/v1/ApplicantApprovalStatus/{id}
Retrieve details for a single applicant approval status 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). |
ApplicantApprovalStatus Member API (3)
POST Gets a list of Applicant Approval Status corresponding to the given data fields.
/prm/api/objects/v1/ApplicantApprovalStatus
Retrieve a list of applicant approval statuses matching the 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 Applicant Approval Status corresponding to the given parameters.
/prm/api/objects/v1/ApplicantApprovalStatus
Retrieve a list of applicant approval statuses matching the specified 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 Applicant Approval Status by id.
/prm/api/objects/v1/ApplicantApprovalStatus/{id}
Retrieve details for a single applicant approval status 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). |
ApplicantAttachment Admin API (11)
PUT Adds a single or many Applicant Attachments based on the specified view model(s).
/api/objects/v1/ApplicantAttachment
Create one or multiple applicant attachments based on the specified view model data.
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 Applicant Attachment by id.
/api/objects/v1/ApplicantAttachment/{id}
Permanently remove a single applicant attachment using 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 Applicant Attachments by id.
/api/objects/v1/ApplicantAttachment
Permanently remove multiple applicant attachments using 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 Applicant Attachments based on the given data fields.
/api/objects/v1/ApplicantAttachment/_export
Export applicant attachments with administrative privileges using filter and selection 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 (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 Applicant Attachments based on the same get parameters.
/api/objects/v1/ApplicantAttachment/_export
Export applicant attachments with administrative privileges based on 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 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 Applicant Attachments corresponding to the given data fields.
/api/objects/v1/ApplicantAttachment
Retrieve a list of applicant attachments with administrative privileges using query criteria 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 Applicant Attachments corresponding to the given parameters.
/api/objects/v1/ApplicantAttachment
Retrieve a list of applicant attachments with administrative privileges filtered by 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 Applicant Attachment by id.
/api/objects/v1/ApplicantAttachment/{id}
Retrieve the details of a single applicant 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). |
GET Gets the Export types available for Applicant Attachment.
/api/objects/v1/ApplicantAttachment/_export/types
Retrieve the list of supported export formats available for applicant attachments in 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 Applicant Attachment based on the specified view model.
/api/objects/v1/ApplicantAttachment/{id}
Update specific fields of an existing applicant 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 Applicant Attachments based on the specified view models.
/api/objects/v1/ApplicantAttachment
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. |
ApplicantAttachment Member API (11)
PUT Adds a single or many Applicant Attachments based on the specified view model(s).
/prm/api/objects/v1/ApplicantAttachment
Create or replace one or more applicant attachments through the Member API using the provided data 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Applicant Attachment by id.
/prm/api/objects/v1/ApplicantAttachment/{id}
Delete a single applicant attachment by its unique identifier through 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 Applicant Attachments by id.
/prm/api/objects/v1/ApplicantAttachment
Delete multiple applicant attachments simultaneously through 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 Applicant Attachments based on the given data fields.
/prm/api/objects/v1/ApplicantAttachment/_export
Export applicant attachments through the Member API using filter 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 (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 Applicant Attachments based on the same get parameters.
/prm/api/objects/v1/ApplicantAttachment/_export
Export applicant attachments through the Member API based on 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 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 Applicant Attachments corresponding to the given data fields.
/prm/api/objects/v1/ApplicantAttachment
Retrieve a list of applicant attachments through the Member API using query 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 Applicant Attachments corresponding to the given parameters.
/prm/api/objects/v1/ApplicantAttachment
Retrieve a list of applicant attachments through the Member API filtered by 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 Applicant Attachment by id.
/prm/api/objects/v1/ApplicantAttachment/{id}
Retrieve the details of a single applicant attachment by its unique identifier through 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 Applicant Attachment.
/prm/api/objects/v1/ApplicantAttachment/_export/types
Retrieve the export types available for applicant attachments through 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 Applicant Attachment based on the specified view model.
/prm/api/objects/v1/ApplicantAttachment/{id}
Update specific fields of an existing applicant attachment by its unique identifier through 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 Applicant Attachments based on the specified view models.
/prm/api/objects/v1/ApplicantAttachment
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. |
AssetCollection Admin API (10)
GET /api/objects/v1/assetcollection/{id}/_inheritedSegments
/api/objects/v1/assetcollection/{id}/_inheritedSegments
Retrieve the inherited segments assigned to a specified asset collection.
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. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Asset Collections based on the specified view model(s).
/api/objects/v1/AssetCollection
Create one or more asset collections using 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 Asset Collection by id.
/api/objects/v1/AssetCollection/{id}
Permanently delete a single asset collection 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 Asset Collections by id.
/api/objects/v1/AssetCollection
Permanently delete multiple asset collections specified 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 Gets a list of Asset Collections corresponding to the given data fields.
/api/objects/v1/AssetCollection
Retrieve a list of asset collections matching the specified request payload 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 Asset Collections corresponding to the given parameters.
/api/objects/v1/AssetCollection
Retrieve a list of asset collections matching the provided 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 all the parent collections of a child collection.
/api/objects/v1/assetcollection/{childId}/_parents
Retrieve all parent collections associated with a specified child collection.
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 integer identifier of the child asset collection. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Asset Collection by id.
/api/objects/v1/AssetCollection/{id}
Retrieve details for a single asset collection 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). |
PATCH Updates a single Asset Collection based on the specified view model.
/api/objects/v1/AssetCollection/{id}
Update specific fields of an existing asset collection by its unique 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. |
|
|
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 Asset Collections based on the specified view models.
/api/objects/v1/AssetCollection
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. |
AssetCollection Member API (10)
GET /prm/api/objects/v1/assetcollection/{id}/_inheritedSegments
/prm/api/objects/v1/assetcollection/{id}/_inheritedSegments
Retrieve the inherited segments assigned to a specified member asset collection.
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. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Asset Collections based on the specified view model(s).
/prm/api/objects/v1/AssetCollection
Create one or more member asset collections using 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 Asset Collection by id.
/prm/api/objects/v1/AssetCollection/{id}
Permanently delete a single member asset collection 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 Asset Collections by id.
/prm/api/objects/v1/AssetCollection
Permanently delete multiple member asset collections specified 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 Gets a list of Asset Collections corresponding to the given data fields.
/prm/api/objects/v1/AssetCollection
Retrieve a list of member asset collections matching the specified request payload 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 Asset Collections corresponding to the given parameters.
/prm/api/objects/v1/AssetCollection
Retrieve a list of member asset collections matching the provided 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 all the parent collections of a child collection.
/prm/api/objects/v1/assetcollection/{childId}/_parents
Retrieve all parent collections associated with a specified member child collection.
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 integer identifier of the child member asset collection. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Asset Collection by id.
/prm/api/objects/v1/AssetCollection/{id}
Retrieve details for a single member asset collection 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). |
PATCH Updates a single Asset Collection based on the specified view model.
/prm/api/objects/v1/AssetCollection/{id}
Update specific fields of an existing member asset collection by its unique 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. |
|
|
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 Asset Collections based on the specified view models.
/prm/api/objects/v1/AssetCollection
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. |
AssetEngagement Admin API (8)
PUT Adds a single or many Asset Engagements based on the specified view model(s).
/api/objects/v1/AssetEngagement
Create one or more asset engagement records using 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 Asset Engagement by id.
/api/objects/v1/AssetEngagement/{id}
Permanently delete a single asset engagement 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 Asset Engagements by id.
/api/objects/v1/AssetEngagement
Permanently delete multiple asset engagement records specified 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 Gets a list of Asset Engagements corresponding to the given data fields.
/api/objects/v1/AssetEngagement
Retrieve a list of asset engagements matching the specified data field criteria. Use this to query engagement records based on complex field values in an administrative 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 Asset Engagements corresponding to the given parameters.
/api/objects/v1/AssetEngagement
Retrieve a list of asset engagements matching the provided query parameters. Use this to search, filter, or paginate through engagement 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 Asset Engagement by id.
/api/objects/v1/AssetEngagement/{id}
Retrieve details for a single asset engagement by its unique identifier. Use this to view administrative details about a specific engagement 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). |
PATCH Updates a single Asset Engagement based on the specified view model.
/api/objects/v1/AssetEngagement/{id}
Update specified fields of an existing asset engagement record. Use this to modify administrative engagement attributes 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 Asset Engagements based on the specified view models.
/api/objects/v1/AssetEngagement
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. |
AssetEngagement Member API (8)
PUT Adds a single or many Asset Engagements based on the specified view model(s).
/prm/api/objects/v1/AssetEngagement
Create or replace one or more asset engagements within the member portal. Use this to record member interaction history with assets.
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 Asset Engagement by id.
/prm/api/objects/v1/AssetEngagement/{id}
Permanently delete a single asset engagement by its unique identifier in 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Asset Engagements by id.
/prm/api/objects/v1/AssetEngagement
Permanently delete multiple asset engagements in bulk from the member portal.
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 Asset Engagements corresponding to the given data fields.
/prm/api/objects/v1/AssetEngagement
Retrieve a list of member asset engagements matching criteria defined in the request body. Use this when filtering member engagement data using complex field 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 Asset Engagements corresponding to the given parameters.
/prm/api/objects/v1/AssetEngagement
Retrieve a list of asset engagements accessible to members based on the provided query parameters. Use this to browse and paginate member 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 Asset Engagement by id.
/prm/api/objects/v1/AssetEngagement/{id}
Retrieve details of a specific asset engagement by its unique identifier 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Asset Engagement based on the specified view model.
/prm/api/objects/v1/AssetEngagement/{id}
Update specific fields of an existing member asset engagement record using its unique 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. |
|
|
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 Asset Engagements based on the specified view models.
/prm/api/objects/v1/AssetEngagement
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. |
AssetPlaybook Member API (11)
PUT Adds a single or many Playbooks based on the specified view model(s).
/prm/api/objects/v1/AssetPlaybook
Create or replace one or more playbooks in the member portal. Use this to set up or update collections of assets 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. |
PATCH Adds an Asset to one or more Playbooks.
/prm/api/objects/v1/AssetPlaybook/AddAsset
Associate an asset with one or more playbooks in the member portal. Use this to link specific content to existing playbook collections.
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 asset to link to the playbooks. |
|
|
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 a single Playbook by id.
/prm/api/objects/v1/AssetPlaybook/{id}
Permanently delete a single playbook by its unique identifier 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Playbooks by id.
/prm/api/objects/v1/AssetPlaybook
Permanently delete multiple playbooks in bulk from the member portal.
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. |
GET Exports the Playbooks based on the same get parameters.
/prm/api/objects/v1/AssetPlaybook/_export
Export playbook records matching query filter parameters. Use this to extract member playbook data for reporting or backup purposes.
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 Gets a Playbook and its Assets.
/prm/api/objects/v1/AssetPlaybook/{id}
Retrieve details for a specific playbook along with its associated assets. Use this to inspect a playbook configuration and view the assets assigned to it.
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 asset attributes to return with each associated asset in the playbook. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Playbooks corresponding to the given data fields.
/prm/api/objects/v1/AssetPlaybook
Retrieve a list of playbooks matching data field criteria specified in the request body. Use this for complex search queries in the member portal.
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 Playbooks corresponding to the given parameters.
/prm/api/objects/v1/AssetPlaybook
Retrieve a list of playbooks matching the specified query parameters. Use this to browse, filter, or paginate playbooks in 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. |
|
|
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). |
PATCH Removes an Asset from the Playbook.
/prm/api/objects/v1/AssetPlaybook/{id}/RemoveAsset
Remove an asset from a specified playbook. Use this to disassociate a collateral item or resource from a member playbook.
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. |
|
|
The unique identifier of the asset to link to the playbooks. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Playbook based on the specified view model.
/prm/api/objects/v1/AssetPlaybook/{id}
Update details of an existing asset playbook based on the specified view model. Use this to modify playbook properties such as titles or configuration 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. |
|
|
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 Playbooks based on the specified view models.
/prm/api/objects/v1/AssetPlaybook
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. |
AssetShare Admin API (8)
PUT Adds a single or many Asset Shares based on the specified view model(s).
/api/objects/v1/AssetShare
Create one or more asset shares as an administrator. Use this to grant administrative access to shared collateral across partner accounts.
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 Asset Share by id.
/api/objects/v1/AssetShare/{id}
Delete a single asset share record by its unique identifier 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 Asset Shares by id.
/api/objects/v1/AssetShare
Delete multiple asset share records in bulk 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Asset Shares corresponding to the given data fields.
/api/objects/v1/AssetShare
Search and retrieve a list of asset shares matching specified filter criteria and data fields 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 Asset Shares corresponding to the given parameters.
/api/objects/v1/AssetShare
Retrieve a list of asset shares 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 Asset Share by id.
/api/objects/v1/AssetShare/{id}
Retrieve details for a single asset share 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 Asset Share based on the specified view model.
/api/objects/v1/AssetShare/{id}
Update properties of an existing asset share record by its unique 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 Asset Shares based on the specified view models.
/api/objects/v1/AssetShare
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. |
AssetShare Member API (8)
PUT Adds a single or many Asset Shares based on the specified view model(s).
/prm/api/objects/v1/AssetShare
Create one or more asset shares from the member portal perspective. Use this to distribute resources to target recipients.
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 Asset Share by id.
/prm/api/objects/v1/AssetShare/{id}
Delete a single asset share by its unique identifier from the member portal 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Asset Shares by id.
/prm/api/objects/v1/AssetShare
Delete multiple asset share records simultaneously from the member portal 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 list of account IDs to delete. |
POST Gets a list of Asset Shares corresponding to the given data fields.
/prm/api/objects/v1/AssetShare
Search and retrieve a list of member-accessible asset shares based on specified 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 Asset Shares corresponding to the given parameters.
/prm/api/objects/v1/AssetShare
Retrieve a list of asset shares available to the member 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 Asset Share by id.
/prm/api/objects/v1/AssetShare/{id}
Retrieve details of a single member-accessible asset share 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). |
PATCH Updates a single Asset Share based on the specified view model.
/prm/api/objects/v1/AssetShare/{id}
Update an existing asset share record from the member portal perspective 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 Asset Shares based on the specified view models.
/prm/api/objects/v1/AssetShare
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. |
Assets Admin API (16)
GET /api/objects/v1/asset/_isvalidasset
/api/objects/v1/asset/_isvalidasset
Check whether an asset at a specified URL is valid and accessible within 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. |
|
|
The URL of the asset to validate. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/asset/{id}/_download
/api/objects/v1/asset/{id}/_download
Download the binary content or file payload for a specific asset.
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 asset to download. |
|
|
The specific version number of the asset to download. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/asset/{id}/_link
/api/objects/v1/asset/{id}/_link
Retrieve an access link or URL for a specified asset.
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 asset whose link is being retrieved. |
|
|
The specific version number of the asset to link to. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/asset/{id}/_thumb
/api/objects/v1/asset/{id}/_thumb
Retrieve the thumbnail image for a specified asset. Use this action to display visual previews of asset content.
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 asset whose link is being retrieved. |
|
|
Specify the dimensions or scale format for the requested thumbnail image. |
|
|
The specific version number of the asset to link to. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/asset/{id}/_view
/api/objects/v1/asset/{id}/_view
Retrieve the viewable representation or preview of an asset by its identifier. Use this action to render or inspect the asset directly.
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 asset whose link is being retrieved. |
|
|
The specific version number of the asset to link to. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Assets based on the specified view model(s).
/api/objects/v1/asset
Create or replace one or more assets using the provided details. Use this action to add new marketing or collateral files and configure their metadata 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 (20)
|
Option Name |
Description |
|---|---|
|
|
The title or display name assigned to the asset. |
|
|
A detailed explanation describing the contents and purpose of the asset. |
|
|
A brief summary or preview text for the asset. |
|
|
The topic or headline associated with the asset. |
|
|
A list of category labels used to classify and organize the asset. |
|
|
The unique identifier of the collection that contains this asset. |
|
|
The unique identifier of the stored binary file or blob associated with the asset. |
|
|
The MIME type describing the format of the asset file. |
|
|
The file extension corresponding to the asset format, such as pdf or png. |
|
|
The unique identifier of the language used in the asset. |
|
|
A numeric value that determines the sorting sequence of the asset within listings. |
|
|
Indicates whether the asset is highlighted as a featured item. |
|
|
Indicates whether users are permitted to share the asset externally. |
|
|
Indicates whether the download option is hidden from users viewing the asset. |
|
|
The current lifecycle or publication status of the asset. |
|
|
The date and time when the asset becomes visible and active for users. |
|
|
The date and time when the asset expires and is no longer active. |
|
|
The external URL or web address linked to the asset. |
|
|
The unique identifier of the cobranding template applied to this asset. |
|
|
An external system identifier associated with the asset. |
DELETE Deletes a single Asset by id.
/api/objects/v1/Asset/{id}
Delete a single asset by its unique identifier. Use this action to permanently remove an obsolete or unwanted asset.
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 Assets by id.
/api/objects/v1/Asset
Delete multiple assets simultaneously. Use this action to perform bulk cleanup of asset 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. |
GET Get share information for a particular Asset.
/api/objects/v1/asset/{id}/_sharestatus
Retrieve the current sharing information and status for an asset. Use this action to verify how an asset is shared or distributed.
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 Id of the Asset in question. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the Asset Id for the most recent version of an Asset.
/api/objects/v1/asset/{id}/_mostRecent
Retrieve the asset identifier for the newest version of an asset. Use this action to locate the latest revision in a versioned series.
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 Id of the Asset in question. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Assets corresponding to the given data fields.
/api/objects/v1/Asset
Query and retrieve a list of assets matching specified data field criteria. Use this action when filtering asset records using structured request 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 (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 Assets corresponding to the given parameters.
/api/objects/v1/Asset
Retrieve a list of assets according to the provided query filters. Use this action to browse or search across available assets.
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 Asset by id.
/api/objects/v1/asset/{id}
Retrieve the full details and metadata of an asset by its identifier. Use this action to inspect a specific asset 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. |
|
|
Optional version number |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
GET Public url to download an asset.
/api/objects/v1/asset/{id}/share/_download
Retrieve the public download link for an asset. Use this action to allow external or unauthorized users to download the shared asset file directly.
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. |
|
|
Asset code only |
|
|
r is the code from ObjectShare table |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Asset based on the specified view model.
/api/objects/v1/Asset/{id}
Update specific fields of an existing asset by its identifier. Use this action to apply partial modifications to asset properties without overwriting unchanged 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. |
|
|
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 Assets based on the specified view models.
/api/objects/v1/Asset
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 (20)
|
Option Name |
Description |
|---|---|
|
|
Specify the updated display title for the assets. |
|
|
Provide a comprehensive description of the assets and their contents. |
|
|
Provide a brief summary or preview text for the assets. |
|
|
Specify the subject line or primary topic associated with the assets. |
|
|
Provide a list of category tags to assign to the assets. |
|
|
Specify the unique identifier of the collection where these assets should reside. |
|
|
Specify the identifier of the binary storage object holding the asset file. |
|
|
Specify the MIME type representing the format of the asset content. |
|
|
Specify the file extension for the assets, such as pdf or png. |
|
|
Specify the identifier of the language associated with these assets. |
|
|
Specify the numeric sorting order used to position the assets in listings. |
|
|
Set to true to highlight the assets as featured content. |
|
|
Set to true to permit users to share the assets externally. |
|
|
Set to true to hide the file download option from users viewing the assets. |
|
|
Specify the lifecycle or publication state of the assets. |
|
|
Specify the date and time when the assets become active and accessible. |
|
|
Specify the date and time when the assets expire and cease to be active. |
|
|
Specify the external destination URL or reference address for the assets. |
|
|
Specify the unique identifier of the cobranding template to apply to the assets. |
|
|
Specify an external system reference identifier for cross-platform mapping. |
Assets Member API (17)
GET /prm/api/objects/v1/asset/{id}/_download
/prm/api/objects/v1/asset/{id}/_download
Download the file content associated with the specified asset. Use this action to retrieve the raw asset payload for local storage or processing.
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 asset whose link is being retrieved. |
|
|
The specific version number of the asset to link to. |
|
|
The response format expected from the API (e.g. application/json). |
POST /prm/api/objects/v1/asset/{id}/_like
/prm/api/objects/v1/asset/{id}/_like
Record or update a user's like status on a specific asset. Use this action to allow members to endorse or toggle their preference for an asset.
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. |
|
|
Set to true to like the asset, or false to remove an existing like. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/asset/{id}/_link
/prm/api/objects/v1/asset/{id}/_link
Retrieve the web link associated with a specific asset. Use this action to obtain the target URL configured for external or linked resources.
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 asset whose link is being retrieved. |
|
|
The specific version number of the asset to link to. |
|
|
The response format expected from the API (e.g. application/json). |
POST /prm/api/objects/v1/asset/{id}/_rate
/prm/api/objects/v1/asset/{id}/_rate
Submit a member rating for the specified asset. Use this action to record feedback scores and evaluate asset performance.
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. |
|
|
Specify the numeric rating score to assign to the asset. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/asset/{id}/_thumb
/prm/api/objects/v1/asset/{id}/_thumb
Retrieve the thumbnail image for a specific asset. Use this action to fetch visual preview media for display in galleries or dashboards.
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 asset whose link is being retrieved. |
|
|
Specify the dimensions or scale format for the requested thumbnail image. |
|
|
The specific version number of the asset to link to. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/asset/{id}/_view
/prm/api/objects/v1/asset/{id}/_view
Access and view the content of a specific asset. Use this action to register an asset view and inspect its online display representation.
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 asset whose link is being retrieved. |
|
|
The specific version number of the asset to link to. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many Assets based on the specified view model(s).
/prm/api/objects/v1/asset
Create one or multiple new assets using the provided view model data.
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 (20)
|
Option Name |
Description |
|---|---|
|
|
The title or display name assigned to the asset. |
|
|
A detailed explanation describing the contents and purpose of the asset. |
|
|
A brief summary or preview text for the asset. |
|
|
The topic or headline associated with the asset. |
|
|
A list of category labels used to classify and organize the asset. |
|
|
The unique identifier of the collection that contains this asset. |
|
|
The unique identifier of the stored binary file or blob associated with the asset. |
|
|
The MIME type describing the format of the asset file. |
|
|
The file extension corresponding to the asset format, such as pdf or png. |
|
|
The unique identifier of the language used in the asset. |
|
|
A numeric value that determines the sorting sequence of the asset within listings. |
|
|
Indicates whether the asset is highlighted as a featured item. |
|
|
Indicates whether users are permitted to share the asset externally. |
|
|
Indicates whether the download option is hidden from users viewing the asset. |
|
|
The current lifecycle or publication status of the asset. |
|
|
The date and time when the asset becomes visible and active for users. |
|
|
The date and time when the asset expires and is no longer active. |
|
|
The external URL or web address linked to the asset. |
|
|
The unique identifier of the cobranding template applied to this asset. |
|
|
An external system identifier associated with the asset. |
DELETE Deletes a single Asset by id.
/prm/api/objects/v1/Asset/{id}
Delete a single existing asset identified by its unique ID.
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 Assets by id.
/prm/api/objects/v1/Asset
Delete multiple assets simultaneously 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. |
GET Get share information for a particular Asset.
/prm/api/objects/v1/asset/{id}/_sharestatus
Retrieve the current share information and status for a specific asset.
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 Id of the Asset in question. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the Asset Id for the most recent version of an Asset.
/prm/api/objects/v1/asset/{id}/_mostRecent
Retrieve the asset ID corresponding to the most recent version of a specified asset.
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 Id of the Asset in question. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Assets corresponding to the given data fields.
/prm/api/objects/v1/Asset
Query and retrieve a list of assets matching the provided data field 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 Assets corresponding to the given parameters.
/prm/api/objects/v1/Asset
Retrieve a list of assets filtered according to 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 Asset by id.
/prm/api/objects/v1/asset/{id}
Retrieve details for a single asset using 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. |
|
|
The unique identifier of the account to view. |
|
|
Optional version number |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
The response format expected from the API (e.g. application/json). |
GET Public url to download an asset.
/prm/api/objects/v1/asset/{id}/share/_download
Retrieve a public URL used to download the specified asset.
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. |
|
|
Asset code only |
|
|
r is the code from ObjectShare table |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Asset based on the specified view model.
/prm/api/objects/v1/Asset/{id}
Update attributes of an existing asset using the provided view model data.
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 Assets based on the specified view models.
/prm/api/objects/v1/Asset
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 (20)
|
Option Name |
Description |
|---|---|
|
|
Specify the updated display title for the assets. |
|
|
Provide a comprehensive description of the assets and their contents. |
|
|
Provide a brief summary or preview text for the assets. |
|
|
Specify the subject line or primary topic associated with the assets. |
|
|
Provide a list of category tags to assign to the assets. |
|
|
Specify the unique identifier of the collection where these assets should reside. |
|
|
Specify the identifier of the binary storage object holding the asset file. |
|
|
Specify the MIME type representing the format of the asset content. |
|
|
Specify the file extension for the assets, such as pdf or png. |
|
|
Specify the identifier of the language associated with these assets. |
|
|
Specify the numeric sorting order used to position the assets in listings. |
|
|
Set to true to highlight the assets as featured content. |
|
|
Set to true to permit users to share the assets externally. |
|
|
Set to true to hide the file download option from users viewing the assets. |
|
|
Specify the lifecycle or publication state of the assets. |
|
|
Specify the date and time when the assets become active and accessible. |
|
|
Specify the date and time when the assets expire and cease to be active. |
|
|
Specify the external destination URL or reference address for the assets. |
|
|
Specify the unique identifier of the cobranding template to apply to the assets. |
|
|
Specify an external system reference identifier for cross-platform mapping. |
Attachment Admin API (4)
DELETE Deletes a single Attachment by id.
/api/objects/v1/Attachment/{id}
Permanently delete a single attachment 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 Attachments by id.
/api/objects/v1/Attachment
Permanently delete multiple attachment records at once 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. |
PATCH Updates a single Attachment based on the specified view model.
/api/objects/v1/Attachment/{id}
Update specific fields of an existing attachment record 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 Attachments based on the specified view models.
/api/objects/v1/Attachment
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. |
Attachment Member API (4)
DELETE Deletes a single Attachment by id.
/prm/api/objects/v1/Attachment/{id}
Permanently delete a single attachment record by its unique identifier using member 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 Attachments by id.
/prm/api/objects/v1/Attachment
Permanently delete multiple attachment records at once using member 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. |
PATCH Updates a single Attachment based on the specified view model.
/prm/api/objects/v1/Attachment/{id}
Update specific fields of an existing attachment record using member 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 Attachments based on the specified view models.
/prm/api/objects/v1/Attachment
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. |
AutoTiering Admin API (17)
POST Demotes (removes the current tier assignment) of partners where their assigned partner level and region (whether they have one or not) do not exist in any structure i.e., no structure has that partners combination of regions and partner levels
/api/objects/v1/autotiering/demoteUnassignablePartners
Demote and remove current tier assignments for partners whose combination of partner level and region does not match any existing auto-tiering structure.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to target for unassignable partner demotions. |
|
|
Specify a list of region IDs to filter partners evaluated for demotion. |
|
|
Specify a list of partner level IDs to filter partners evaluated for demotion. |
POST Get metric data for pcm
/api/objects/v1/autotiering/metricsForPcm
Retrieve partner channel management metric data for specified accounts over a defined date range.
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 (4)
|
Option Name |
Description |
|---|---|
|
|
The beginning date for filtering the metric data collection window. |
|
|
The ending date for filtering the metric data collection window. |
|
|
A list of specific metric names to retrieve data for. |
|
|
A list of account IDs to include in the metric retrieval. |
GET Get the current tier over ride info for an account
/api/objects/v1/autotiering/accountTierOverride/{accountId}
Retrieve the current tier override details and status for a specified partner 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. |
|
|
The unique identifier of the partner account whose tier override information is being retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the auto tiering active fields
/api/objects/v1/autotiering/_activeTierRequirements
Retrieve the list of active requirement fields currently configured for auto-tiering evaluation.
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 auto tiering active fields combined with all possible other fields that might be added to the snapshot table
/api/objects/v1/autotiering/_accountSnapshotFields
Retrieve active auto-tiering fields alongside all potential additional fields available for the account snapshot table.
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 benefits custom fields that are a picklist of some sort
/api/objects/v1/autotiering/benefits
Retrieve custom benefit fields configured as picklists for auto-tiering.
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 the count of partners not in a tier associated with a set of regions and partner levels that is, that are associated with a structure, but don't meet the requirements for the lowest tier in that structure
/api/objects/v1/autotiering/structurelessPartnersCount
Retrieve the total count of partners that belong to a tier structure based on region and partner level but do not meet the minimum requirements for its lowest tier.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to filter the structure partner count. |
|
|
Specify a list of region IDs to filter which partners are counted. |
|
|
Specify a list of partner level IDs to filter which partners are counted. |
POST Gets the list of partners not in a tier associated with a set of regions and partner levels that is, the basic parameters of a tier structure
/api/objects/v1/autotiering/structurelessPartnersList
Retrieve a list of partners that match a tier structure by region and level but have not qualified for any tier.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to filter the structure partner count. |
|
|
Specify a list of region IDs to filter which partners are counted. |
|
|
Specify a list of partner level IDs to filter which partners are counted. |
POST Gets the list of partners without a matching set of structure regions and partner levels that is, the basic parameters of a tier structure i.e., partners that will never be assigned a tier or demoted to no tier in a structure
/api/objects/v1/autotiering/unassignablePartnersCount
Retrieve the total count of partners whose region and partner level combinations do not match any tier structure and therefore cannot be assigned a tier.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to target for unassignable partner demotions. |
|
|
Specify a list of region IDs to filter partners evaluated for demotion. |
|
|
Specify a list of partner level IDs to filter partners evaluated for demotion. |
POST Gets the list of partners without a matching set of structure regions and partner levels that is, the basic parameters of a tier structure i.e., partners that will never be assigned a tier or demoted to no tier in a structure
/api/objects/v1/autotiering/unassignablePartnersList
Retrieve a paginated list of partners whose region and partner level combinations do not match any tier structure, preventing them from being assigned to a tier.
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. |
|
|
Specify the maximum number of partner records to return. |
|
|
Specify the number of partner records to skip before returning results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to target for unassignable partner demotions. |
|
|
Specify a list of region IDs to filter partners evaluated for demotion. |
|
|
Specify a list of partner level IDs to filter partners evaluated for demotion. |
POST Gets the most recent snapshot ids for all partners
/api/objects/v1/autotiering/mostRecentSnapshots
Retrieve the most recent tiering snapshot records for partners.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of partner identifiers to restrict which snapshots are returned. |
|
|
Specify a list of field names to include from the snapshot records. |
|
|
Specify a target date formatted string to filter snapshot evaluation results. |
GET Gets the name and badge belong to a tier using the account id
/api/objects/v1/autotiering/tierNameAndBadge/{accountId}
Retrieve the tier name and badge information assigned to a specific 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. |
|
|
The unique identifier of the partner account whose tier override information is being retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets the name and badge belonging to a tier using a list of account ids
/api/objects/v1/autotiering/tierNameAndBadge
Retrieve tier names and badge details for multiple partner accounts 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. |
GET Gets the partners that belong to a tier using the structure tier uuid
/api/objects/v1/autotiering/getPartnersByTierId/{tierUuid}
Retrieve all partners assigned to a specific structure tier.
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 structure tier. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets the snapshot history for a partner
/api/objects/v1/autotiering/snapshotsHistory
Retrieve the historical log of tiering snapshots for a specific 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 unique identifier of the partner account to retrieve snapshot history for. |
PUT Reset tier overrides that are expired
/api/objects/v1/autotiering/resetExpiredTierOverrides
Reset expired manual tier overrides across all partner accounts back to their calculated tiers.
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). |
PUT update tier over ride info in the account object
/api/objects/v1/autotiering/accountTierOverride
Update or apply a manual tier override on a partner account, including expiration rules and evaluation options.
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 (5)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the account receiving the tier override. |
|
|
The identifier of the tier to manually assign to the account. |
|
|
The date when the tier override will expire and no longer take effect. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
Indicates whether the account tier should be automatically evaluated after the override expires. |
AutoTiering Member API (17)
POST Demotes (removes the current tier assignment) of partners where their assigned partner level and region (whether they have one or not) do not exist in any structure i.e., no structure has that partners combination of regions and partner levels
/prm/api/objects/v1/autotiering/demoteUnassignablePartners
Remove active tier assignments from partners whose region and level settings no longer exist in any tier structure.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to target for unassignable partner demotions. |
|
|
Specify a list of region IDs to filter partners evaluated for demotion. |
|
|
Specify a list of partner level IDs to filter partners evaluated for demotion. |
POST Get metric data for pcm
/prm/api/objects/v1/autotiering/metricsForPcm
Retrieve auto-tiering metric data for partner channel management.
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 (4)
|
Option Name |
Description |
|---|---|
|
|
The beginning date for filtering the metric data collection window. |
|
|
The ending date for filtering the metric data collection window. |
|
|
A list of specific metric names to retrieve data for. |
|
|
A list of account IDs to include in the metric retrieval. |
GET Get the current tier over ride info for an account
/prm/api/objects/v1/autotiering/accountTierOverride/{accountId}
Retrieve the active tier override details and configuration for a specific 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. |
|
|
The unique identifier of the partner account whose tier override information is being retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the auto tiering active fields
/prm/api/objects/v1/autotiering/_activeTierRequirements
Retrieve the active requirement fields configured for auto-tiering rules.
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 auto tiering active fields combined with all possible other fields that might be added to the snapshot table
/prm/api/objects/v1/autotiering/_accountSnapshotFields
Retrieve all active auto-tiering requirement fields along with any additional fields available for account snapshot tables.
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 benefits custom fields that are a picklist of some sort
/prm/api/objects/v1/autotiering/benefits
Retrieve custom benefit fields that are configured as picklist types.
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 the count of partners not in a tier associated with a set of regions and partner levels that is, that are associated with a structure, but don't meet the requirements for the lowest tier in that structure
/prm/api/objects/v1/autotiering/structurelessPartnersCount
Retrieve the count of partners that belong to a structure based on their region and level but do not meet the criteria for its lowest tier.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to filter the structure partner count. |
|
|
Specify a list of region IDs to filter which partners are counted. |
|
|
Specify a list of partner level IDs to filter which partners are counted. |
POST Gets the list of partners not in a tier associated with a set of regions and partner levels that is, the basic parameters of a tier structure
/prm/api/objects/v1/autotiering/structurelessPartnersList
Retrieve a list of partners who are not assigned to a tier within the specified tier structure parameters.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to filter the structure partner count. |
|
|
Specify a list of region IDs to filter which partners are counted. |
|
|
Specify a list of partner level IDs to filter which partners are counted. |
POST Gets the list of partners without a matching set of structure regions and partner levels that is, the basic parameters of a tier structure i.e., partners that will never be assigned a tier or demoted to no tier in a structure
/prm/api/objects/v1/autotiering/unassignablePartnersCount
Retrieve the total count of partners that do not match the required regions and partner levels for any tier structure.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to target for unassignable partner demotions. |
|
|
Specify a list of region IDs to filter partners evaluated for demotion. |
|
|
Specify a list of partner level IDs to filter partners evaluated for demotion. |
POST Gets the list of partners without a matching set of structure regions and partner levels that is, the basic parameters of a tier structure i.e., partners that will never be assigned a tier or demoted to no tier in a structure
/prm/api/objects/v1/autotiering/unassignablePartnersList
Retrieve a list of partners that lack matching tier structure parameters and cannot be assigned to or demoted within a tier.
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. |
|
|
Specify the maximum number of partner records to return. |
|
|
Specify the number of partner records to skip before returning results. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of tier UUIDs to target for unassignable partner demotions. |
|
|
Specify a list of region IDs to filter partners evaluated for demotion. |
|
|
Specify a list of partner level IDs to filter partners evaluated for demotion. |
POST Gets the most recent snapshot ids for all partners
/prm/api/objects/v1/autotiering/mostRecentSnapshots
Retrieve the most recent auto-tiering snapshot identifiers for all partners.
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 (3)
|
Option Name |
Description |
|---|---|
|
|
Specify a list of partner identifiers to restrict which snapshots are returned. |
|
|
Specify a list of field names to include from the snapshot records. |
|
|
Specify a target date formatted string to filter snapshot evaluation results. |
GET Gets the name and badge belong to a tier using the account id
/prm/api/objects/v1/autotiering/tierNameAndBadge/{accountId}
Retrieve the tier name and badge associated with a specific partner 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. |
|
|
The unique identifier of the partner account whose tier override information is being retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets the name and badge belonging to a tier using a list of account ids
/prm/api/objects/v1/autotiering/tierNameAndBadge
Retrieve tier names and badges for multiple partner accounts 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. |
GET Gets the partners that belong to a tier using the structure tier uuid
/prm/api/objects/v1/autotiering/getPartnersByTierId/{tierUuid}
Retrieve all partners assigned to a specific tier using the tier 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. |
|
|
The unique identifier of the structure tier. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets the snapshot history for a partner
/prm/api/objects/v1/autotiering/snapshotsHistory
Retrieve the historical record of auto-tiering snapshots for a specified partner.
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 unique identifier of the account receiving the tier override. |
PUT Reset tier overrides that are expired
/prm/api/objects/v1/autotiering/resetExpiredTierOverrides
Reset any manual tier overrides that have passed their expiration date.
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). |
PUT update tier over ride info in the account object
/prm/api/objects/v1/autotiering/accountTierOverride
Update the manual tier override details stored on a partner 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 (5)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the account receiving the tier override. |
|
|
The identifier of the tier to manually assign to the account. |
|
|
The date when the tier override will expire and no longer take effect. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
Indicates whether the account tier should be automatically evaluated after the override expires. |
AzureBlob Admin API (3)
POST Gets a list of File Blobs corresponding to the given data fields.
/api/objects/v1/AzureBlob
Query and retrieve a list of Azure File Blobs based on fields provided 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 File Blobs corresponding to the given parameters.
/api/objects/v1/AzureBlob
Retrieve a list of Azure File Blobs matching specified query criteria 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 File Blob by id.
/api/objects/v1/AzureBlob/{id}
Retrieve details for a single Azure File Blob 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). |
AzureBlob Member API (3)
POST Gets a list of File Blobs corresponding to the given data fields.
/prm/api/objects/v1/AzureBlob
Query and retrieve a list of Azure File Blobs based on fields provided in the request body using member 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 File Blobs corresponding to the given parameters.
/prm/api/objects/v1/AzureBlob
Retrieve a list of Azure File Blobs matching specified query criteria using member 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 File Blob by id.
/prm/api/objects/v1/AzureBlob/{id}
Retrieve details for a single Azure File Blob by its unique identifier using member 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). |
AzureBlobTemp Admin API (8)
POST Exports the File Blob Temps based on the given data fields.
/api/objects/v1/AzureBlobTemp/_export
Export temporary Azure file blob records matching the filter criteria specified in the request body. Use this administrative action to extract blob data based on complex search 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 (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 File Blob Temps based on the same get parameters.
/api/objects/v1/AzureBlobTemp/_export
Export temporary Azure file blob records matching query parameters. Use this administrative action to export filtered file blob datasets.
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 File Blob Temps corresponding to the given data fields.
/api/objects/v1/AzureBlobTemp
Retrieve a list of temporary Azure file blob records matching criteria specified in the request payload. Use this in administrative workflows when complex query parameters are 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 File Blob Temps corresponding to the given parameters.
/api/objects/v1/AzureBlobTemp
Retrieve a list of temporary Azure file blob records matching the specified query parameters. Use this in administrative workflows to browse or search blob 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 File Blob Temp by id.
/api/objects/v1/AzureBlobTemp/{id}
Retrieve the details of a specific temporary Azure file blob record by its unique identifier. Use this in administrative tasks to inspect an individual blob's 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 Gets the Export types available for File Blob Temp.
/api/objects/v1/AzureBlobTemp/_export/types
Retrieve the available export format types for temporary Azure file blobs. Use this administrative action to discover supported export options prior to 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 File Blob Temp based on the specified view model.
/api/objects/v1/AzureBlobTemp/{id}
Update specific fields of an existing temporary Azure file blob record using its unique identifier. Use this administrative action to apply partial updates to blob 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 File Blob Temps based on the specified view models.
/api/objects/v1/AzureBlobTemp
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. |
AzureBlobTemp Member API (8)
POST Exports the File Blob Temps based on the given data fields.
/prm/api/objects/v1/AzureBlobTemp/_export
Export temporary Azure file blob records accessible to portal members based on criteria in the request body. Use this in member-facing workflows to extract filtered blob 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 (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 File Blob Temps based on the same get parameters.
/prm/api/objects/v1/AzureBlobTemp/_export
Export temporary Azure file blob records accessible to portal members based on query parameters. Use this in member integrations to export filtered blob datasets.
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 File Blob Temps corresponding to the given data fields.
/prm/api/objects/v1/AzureBlobTemp
Retrieve a list of temporary Azure file blob records accessible to portal members based on criteria specified in the request body. Use this for complex search queries within member integrations.
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 File Blob Temps corresponding to the given parameters.
/prm/api/objects/v1/AzureBlobTemp
Retrieve a list of temporary Azure file blob records accessible to portal members matching query parameters. Use this to view or search member-accessible blob items.
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 File Blob Temp by id.
/prm/api/objects/v1/AzureBlobTemp/{id}
Retrieve a single temporary Azure file blob record by its unique identifier within the member context. Use this to view details of a specific blob accessible to a portal 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 File Blob Temp.
/prm/api/objects/v1/AzureBlobTemp/_export/types
Retrieve the available export format types for temporary Azure file blobs in the member portal. Use this to identify supported formats before running a member-level 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 File Blob Temp based on the specified view model.
/prm/api/objects/v1/AzureBlobTemp/{id}
Update fields of an existing temporary Azure file blob record by its unique identifier within the member context. Use this to apply partial updates to member-accessible blob 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. |
|
|
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 File Blob Temps based on the specified view models.
/prm/api/objects/v1/AzureBlobTemp
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. |
BPPartnerPlanCompletionHistory Admin API (3)
POST Gets a list of Completion Histories corresponding to the given data fields.
/api/objects/v1/BPPartnerPlanCompletionHistory
Retrieve a list of partner plan completion histories matching specified data fields using administrative privileges. Use this when complex criteria or large field filters are 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 Completion Histories corresponding to the given parameters.
/api/objects/v1/BPPartnerPlanCompletionHistory
Retrieve a list of partner plan completion histories matching query parameters using administrative privileges. Use this for standard administrative searches and filtering.
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 Completion History by id.
/api/objects/v1/BPPartnerPlanCompletionHistory/{id}
Retrieve details of a single partner plan completion history by its identifier using administrative privileges. Use this when you need detailed administrative records for a specific completion history entry.
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). |
BPPartnerPlanCompletionHistory Member API (3)
POST Gets a list of Completion Histories corresponding to the given data fields.
/prm/api/objects/v1/BPPartnerPlanCompletionHistory
Retrieve a list of partner plan completion histories matching specified data fields via the member API. Use this when querying completion history records within a member context using 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 Completion Histories corresponding to the given parameters.
/prm/api/objects/v1/BPPartnerPlanCompletionHistory
Retrieve a list of partner plan completion histories matching query parameters via the member API. Use this for member-level viewing and searching of completion 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 Completion History by id.
/prm/api/objects/v1/BPPartnerPlanCompletionHistory/{id}
Retrieve a single partner plan completion history by its identifier via the member API. Use this to view member-accessible details for a specific completion 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). |
BPPartnerPlanCustomMetric Admin API (3)
POST Gets a list of Plan Custom Metrics corresponding to the given data fields.
/api/objects/v1/BPPartnerPlanCustomMetric
Retrieve a list of partner plan custom metrics matching specified data fields using administrative privileges. Use this when querying custom metrics based on field values passed 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 Plan Custom Metrics corresponding to the given parameters.
/api/objects/v1/BPPartnerPlanCustomMetric
Retrieve a list of partner plan custom metrics matching query parameters using administrative privileges. Use this for administrative listing and filtering of custom plan metrics.
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 Plan Custom Metric by id.
/api/objects/v1/BPPartnerPlanCustomMetric/{id}
Retrieve a single partner plan custom metric by its identifier using administrative privileges. Use this to view detailed administrative configuration and data for a specific metric.
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). |
BPPartnerPlanCustomMetric Member API (3)
POST Gets a list of Plan Custom Metrics corresponding to the given data fields.
/prm/api/objects/v1/BPPartnerPlanCustomMetric
Retrieve a list of partner plan custom metrics matching specified data fields via the member API. Use this when filtering custom metrics in the member portal using body-defined 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 Plan Custom Metrics corresponding to the given parameters.
/prm/api/objects/v1/BPPartnerPlanCustomMetric
Retrieve a list of partner plan custom metrics matching query parameters via the member API. Use this for searching and viewing partner plan custom metrics from a member 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. |
|
|
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 Plan Custom Metric by id.
/prm/api/objects/v1/BPPartnerPlanCustomMetric/{id}
Retrieve a single partner plan custom metric by its identifier via the member API. Use this to look up a specific custom metric accessible 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
BPPartnerPlanCustomMetricTarget Admin API (8)
PUT Adds a single or many Plan Custom Metric Targets based on the specified view model(s).
/api/objects/v1/BPPartnerPlanCustomMetricTarget
Create or replace one or more partner plan custom metric targets using administrative privileges. Use this to set target values for custom metrics across partner plans.
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 Plan Custom Metric Target by id.
/api/objects/v1/BPPartnerPlanCustomMetricTarget/{id}
Permanently delete a single partner plan custom metric target by its identifier using administrative privileges. Use this to remove an individual metric target.
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 Plan Custom Metric Targets by id.
/api/objects/v1/BPPartnerPlanCustomMetricTarget
Permanently delete multiple partner plan custom metric targets by their identifiers using administrative privileges. Use this for bulk removal of metric targets.
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 Plan Custom Metric Targets corresponding to the given data fields.
/api/objects/v1/BPPartnerPlanCustomMetricTarget
Retrieve a list of partner plan custom metric targets matching specified data fields using administrative privileges. Use this when filtering targets by body payload 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. |
|
|
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 Plan Custom Metric Targets corresponding to the given parameters.
/api/objects/v1/BPPartnerPlanCustomMetricTarget
Retrieve a list of partner plan custom metric targets matching query parameters using administrative privileges. Use this for administrative search and inspection of custom metric targets.
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 Plan Custom Metric Target by id.
/api/objects/v1/BPPartnerPlanCustomMetricTarget/{id}
Retrieve a single partner plan custom metric target by its identifier using administrative privileges. Use this to view details of a specific target 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). |
PATCH Updates a single Plan Custom Metric Target based on the specified view model.
/api/objects/v1/BPPartnerPlanCustomMetricTarget/{id}
Update specific fields of an existing partner plan custom metric target by its identifier using administrative privileges. Use this to modify target thresholds or configurations without replacing the whole 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 Plan Custom Metric Targets based on the specified view models.
/api/objects/v1/BPPartnerPlanCustomMetricTarget
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. |
BPPartnerPlanCustomMetricTarget Member API (8)
PUT Adds a single or many Plan Custom Metric Targets based on the specified view model(s).
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget
Create one or more partner plan custom metric targets in the member portal 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 Plan Custom Metric Target by id.
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget/{id}
Permanently remove a single partner plan custom metric target by its unique identifier in 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Plan Custom Metric Targets by id.
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget
Permanently remove multiple partner plan custom metric targets by their unique identifiers in the member portal.
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 Plan Custom Metric Targets corresponding to the given data fields.
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget
Retrieve a list of partner plan custom metric targets matching specified data fields 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 Plan Custom Metric Targets corresponding to the given parameters.
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget
Retrieve a list of partner plan custom metric targets based on 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 Plan Custom Metric Target by id.
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget/{id}
Retrieve details of a single partner plan custom metric target by its unique identifier in 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Plan Custom Metric Target based on the specified view model.
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget/{id}
Update specific fields of an existing partner plan custom metric target by its unique identifier in the member portal.
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 Plan Custom Metric Targets based on the specified view models.
/prm/api/objects/v1/BPPartnerPlanCustomMetricTarget
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. |
BPPartnerPlanNote Admin API (8)
PUT Adds a single or many Plan Notes based on the specified view model(s).
/api/objects/v1/BPPartnerPlanNote
Create one or more partner plan notes in the admin portal 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 Plan Note by id.
/api/objects/v1/BPPartnerPlanNote/{id}
Permanently remove a single partner plan note by its unique identifier in the admin 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Plan Notes by id.
/api/objects/v1/BPPartnerPlanNote
Permanently remove multiple partner plan notes by their unique identifiers in the admin portal.
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 Plan Notes corresponding to the given data fields.
/api/objects/v1/BPPartnerPlanNote
Retrieve a list of partner plan notes matching specified data fields 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 Plan Notes corresponding to the given parameters.
/api/objects/v1/BPPartnerPlanNote
Retrieve a list of partner plan notes in the admin portal based on 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 Plan Note by id.
/api/objects/v1/BPPartnerPlanNote/{id}
Retrieve details of a single partner plan note by its unique identifier in the admin 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Plan Note based on the specified view model.
/api/objects/v1/BPPartnerPlanNote/{id}
Update specific fields of an existing partner plan note by its unique identifier in the admin portal.
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 Plan Notes based on the specified view models.
/api/objects/v1/BPPartnerPlanNote
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. |
BPPartnerPlanNote Member API (8)
PUT Adds a single or many Plan Notes based on the specified view model(s).
/prm/api/objects/v1/BPPartnerPlanNote
Create one or more partner plan notes in the member portal 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 Plan Note by id.
/prm/api/objects/v1/BPPartnerPlanNote/{id}
Permanently remove a single partner plan note by its unique identifier in 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Plan Notes by id.
/prm/api/objects/v1/BPPartnerPlanNote
Permanently remove multiple partner plan notes by their unique identifiers in the member portal.
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 Plan Notes corresponding to the given data fields.
/prm/api/objects/v1/BPPartnerPlanNote
Retrieve a list of partner plan notes in the member portal matching specified data fields 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 Plan Notes corresponding to the given parameters.
/prm/api/objects/v1/BPPartnerPlanNote
Retrieve a list of partner plan notes matching the specified query parameters. Use this action to inspect or filter notes attached to partner business plans.
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 Plan Note by id.
/prm/api/objects/v1/BPPartnerPlanNote/{id}
Retrieve a single partner plan note by its unique identifier. Use this action to review the contents and metadata of an individual plan 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 |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Plan Note based on the specified view model.
/prm/api/objects/v1/BPPartnerPlanNote/{id}
Update an existing partner plan note using the provided view model. Use this action to modify the details or contents of a plan note.
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 Plan Notes based on the specified view models.
/prm/api/objects/v1/BPPartnerPlanNote
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. |
BPPlan Admin API (4)
DELETE Deletes a single Business Plan by id.
/api/objects/v1/BPPlan/{id}
Delete a single business plan by its identifier using administrative permissions. Use this action to permanently remove an individual plan.
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 Business Plans by id.
/api/objects/v1/BPPlan
Delete multiple business plans by their identifiers using administrative permissions. Use this action to remove several plans in a single batch 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. |
PATCH Updates a single Business Plan based on the specified view model.
/api/objects/v1/BPPlan/{id}
Update specific fields of an existing business plan using administrative permissions. Use this action to apply modifications to a business plan.
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 Business Plans based on the specified view models.
/api/objects/v1/BPPlan
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. |
BPPlan Member API (4)
DELETE Deletes a single Business Plan by id.
/prm/api/objects/v1/BPPlan/{id}
Delete a single business plan by its identifier through the member interface. Use this action when a member user needs to remove a specific business plan.
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 Business Plans by id.
/prm/api/objects/v1/BPPlan
Delete multiple business plans by their identifiers through the member interface. Use this action when a member user needs to remove multiple business plans at once.
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 Business Plan based on the specified view model.
/prm/api/objects/v1/BPPlan/{id}
Update specific fields of an existing business plan through the member interface. Use this action to apply changes to a business plan on behalf of 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 Business Plans based on the specified view models.
/prm/api/objects/v1/BPPlan
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. |
BPTemplateCustomMetric Admin API (8)
PUT Adds a single or many Template Custom Metrics based on the specified view model(s).
/api/objects/v1/BPTemplateCustomMetric
Create or replace one or more business plan template custom metrics using administrative permissions. Use this action to define or overwrite custom metric 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Template Custom Metric by id.
/api/objects/v1/BPTemplateCustomMetric/{id}
Delete a single template custom metric by its identifier using administrative permissions. Use this action to remove a specific custom metric from plan templates.
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 Template Custom Metrics by id.
/api/objects/v1/BPTemplateCustomMetric
Delete multiple template custom metrics by their identifiers using administrative permissions. Use this action to batch remove metric definitions from plan templates.
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 Template Custom Metrics corresponding to the given data fields.
/api/objects/v1/BPTemplateCustomMetric
Retrieve a list of template custom metrics matching the criteria in the request body using administrative permissions. Use this action to filter custom metrics by 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 Template Custom Metrics corresponding to the given parameters.
/api/objects/v1/BPTemplateCustomMetric
Retrieve a list of template custom metrics matching query parameters using administrative permissions. Use this action to browse or paginate through custom metric 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 Template Custom Metric by id.
/api/objects/v1/BPTemplateCustomMetric/{id}
Retrieve a single template custom metric by its unique identifier using administrative permissions. Use this action to inspect the configuration details of a metric.
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 Template Custom Metric based on the specified view model.
/api/objects/v1/BPTemplateCustomMetric/{id}
Update fields of an existing template custom metric using administrative permissions. Use this action to modify properties of a template metric definition.
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 Template Custom Metrics based on the specified view models.
/api/objects/v1/BPTemplateCustomMetric
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. |
BPTemplateCustomMetric Member API (8)
PUT Adds a single or many Template Custom Metrics based on the specified view model(s).
/prm/api/objects/v1/BPTemplateCustomMetric
Create or replace one or more template custom metrics through the member interface. Use this action to add or overwrite custom metric definitions for business plan templates.
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 Template Custom Metric by id.
/prm/api/objects/v1/BPTemplateCustomMetric/{id}
Delete a single template custom metric by its identifier through the member interface. Use this action to remove an individual custom metric 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Template Custom Metrics by id.
/prm/api/objects/v1/BPTemplateCustomMetric
Delete multiple template custom metrics by their identifiers through the member interface. Use this action to remove several custom metric configurations at once.
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 Template Custom Metrics corresponding to the given data fields.
/prm/api/objects/v1/BPTemplateCustomMetric
Retrieve a list of template custom metrics matching the criteria in the request body through the member interface. Use this action to filter custom metrics by specified 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 Template Custom Metrics corresponding to the given parameters.
/prm/api/objects/v1/BPTemplateCustomMetric
Retrieve a list of template custom metrics matching the specified criteria for 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. |
|
|
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 Template Custom Metric by id.
/prm/api/objects/v1/BPTemplateCustomMetric/{id}
Retrieve the details of a specific template custom metric by its unique identifier for 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Template Custom Metric based on the specified view model.
/prm/api/objects/v1/BPTemplateCustomMetric/{id}
Update specific fields of an existing template custom metric by its unique identifier for the member portal.
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 Template Custom Metrics based on the specified view models.
/prm/api/objects/v1/BPTemplateCustomMetric
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. |
Benefit Admin API (8)
PUT Adds a single or many Benefits based on the specified view model(s).
/api/objects/v1/Benefit
Create or replace one or more benefits 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 Benefit by id.
/api/objects/v1/Benefit/{id}
Permanently remove a single benefit 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 Benefits by id.
/api/objects/v1/Benefit
Permanently remove multiple benefits 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 Benefits corresponding to the given data fields.
/api/objects/v1/Benefit
Retrieve a filtered list of benefits matching the criteria provided 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 Benefits corresponding to the given parameters.
/api/objects/v1/Benefit
Retrieve a list of benefits corresponding to 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 Benefit by id.
/api/objects/v1/Benefit/{id}
Retrieve the details of a single benefit 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 Benefit based on the specified view model.
/api/objects/v1/Benefit/{id}
Update specific fields of an existing benefit 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 Benefits based on the specified view models.
/api/objects/v1/Benefit
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. |
Benefit Member API (8)
PUT Adds a single or many Benefits based on the specified view model(s).
/prm/api/objects/v1/Benefit
Create or replace one or more benefits through the member portal.
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 Benefit by id.
/prm/api/objects/v1/Benefit/{id}
Permanently remove a single benefit by its unique identifier through 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Benefits by id.
/prm/api/objects/v1/Benefit
Permanently remove multiple benefits through the member portal.
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 Benefits corresponding to the given data fields.
/prm/api/objects/v1/Benefit
Retrieve a filtered list of benefits matching the criteria provided in the request body through the member portal.
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 Benefits corresponding to the given parameters.
/prm/api/objects/v1/Benefit
Retrieve a list of benefits matching the specified query parameters through 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. |
|
|
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 Benefit by id.
/prm/api/objects/v1/Benefit/{id}
Retrieve the details of a specific benefit by its unique identifier through 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Benefit based on the specified view model.
/prm/api/objects/v1/Benefit/{id}
Update specific fields of an existing benefit by its unique identifier through the member portal.
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 Benefits based on the specified view models.
/prm/api/objects/v1/Benefit
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. |
Blob Admin API (2)
GET /api/objects/v1/blob/_config
/api/objects/v1/blob/_config
Retrieve configuration settings for blob storage, optionally filtered by related object type or temporary container status.
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. |
|
|
Specify the related entity or object type to filter the blob storage configuration. |
|
|
Specify whether to retrieve configuration for temporary storage containers. |
|
|
The response format expected from the API (e.g. application/json). |
PUT /api/objects/v1/blob/_upload
/api/objects/v1/blob/_upload
Upload a file blob into storage with options to associate it with an entity type or mark it as temporary.
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. |
|
|
Specify the related object or entity type to associate with the uploaded blob. |
|
|
Indicate whether the uploaded blob should be treated as temporary storage. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide the file content to be uploaded. |
Blob Member API (2)
GET /prm/api/objects/v1/blob/_config
/prm/api/objects/v1/blob/_config
Retrieve the current configuration settings for blob storage in 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. |
|
|
Specify the related object or entity type to associate with the uploaded blob. |
|
|
Specify whether to retrieve configuration for temporary storage containers. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Create Blob
/prm/api/objects/v1/blob/_upload
Upload and create a new blob object.
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. |
|
|
Specify the related object or entity type to associate with the uploaded blob. |
|
|
Indicate whether the uploaded blob should be treated as temporary storage. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
(multipart/form-data field)` Binary file of asset |
BusinessPlanning Admin API (13)
POST Checks the THQL to see if it is valid and if so, write to the database
/api/objects/v1/businessplanning/thqlvalidator
Validate a THQL query string and save it to the database if validation succeeds.
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 THQL query string to validate and persist. |
POST Gets a list of requested Metrics containing the queryParameters but not the items this is in preparation for executing a list of metrics
/api/objects/v1/businessplanning/getBPMetricsQueryParameters
Retrieve the query parameters for a requested list of business planning metrics in preparation for metric execution.
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. |
GET Gets the list of available custom json queries
/api/objects/v1/businessplanning/customQueryList
Retrieve a list of all available custom JSON queries for business planning.
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 list of available json queries
/api/objects/v1/businessplanning/defaultQueryList
Retrieve a list of all default JSON queries available for business planning.
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 the list of available partnership goals, i.e., non numeric objectives
/api/objects/v1/businessplanning/getPartnershipGoalsByIds
Retrieve partnership goals matching specified IDs and criteria, returning non-numeric objectives.
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 |
|---|---|
|
|
Specify the updated display title for the assets. |
|
|
Filter goals by category name. |
|
|
Provide a comprehensive description of the assets and their contents. |
|
|
Specify the numeric sorting order used to position the assets in listings. |
|
|
The unique identifier of the partnership goal. |
|
|
The title or description of the partnership goal. |
|
|
The number of days allowed to reach the goal deadline. |
|
|
The completion percentage of the goal. |
GET Gets the list of current Metrics for business plan this does NOT return the complete metric JSON
/api/objects/v1/businessplanning/getBPPlanMetrics/{planId}
Retrieve a summary list of current metrics associated with a specific business plan without returning full metric JSON payloads.
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 business plan. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the list of current Template Metrics
/api/objects/v1/businessplanning/getMetric/{metricName}
Retrieve metric details for a specific template metric by name.
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 name of the metric to look up. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the list of current Template Metrics for Template display this does NOT return the complete metric JSON
/api/objects/v1/businessplanning/getBPPlanMetricsWithTargets/{planId}
Retrieve current business plan metrics along with their targets for display purposes.
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 business plan. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the list of current Template Metrics for Template display this does NOT return the complete metric JSON
/api/objects/v1/businessplanning/getBPTemplateMetrics/{templateId}
Retrieve metrics associated with a business planning template for display purposes.
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 business planning template. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets the list of custom metric data
/api/objects/v1/businessplanning/getCustomMetricsByIds
Retrieve custom metric records matching specified identifiers and configuration options.
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 (11)
|
Option Name |
Description |
|---|---|
|
|
The API name of the custom metric. |
|
|
The category classification for the metric. |
|
|
The display group name to which the metric belongs. |
|
|
List of system feature keys required to support this metric. |
|
|
Provide a comprehensive description of the assets and their contents. |
|
|
Specify the numeric sorting order used to position the assets in listings. |
|
|
Indicates whether the metric represents a single value rather than a time series or multi-value set. |
|
|
The time period classification for setting the metric target, such as monthly or quarterly. |
|
|
The unit or target type applied to the metric. |
|
|
Indicates whether the metric is mandatory for the plan. |
|
|
The unique identifier of the custom metric. |
POST Gets the partnership goal from the bp partnership plan goal or bp partner ship goal depending on if it is an update or add.
/api/objects/v1/businessplanning/getPartnerPlanGoals
Retrieve partner plan goals based on plan or template context for either creating or modifying goals.
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 (4)
|
Option Name |
Description |
|---|---|
|
|
Specifies whether the operation context is adding or updating a goal. |
|
|
The unique identifier of the business plan. |
|
|
The unique identifier of the business planning template. |
|
|
Filters goals based on whether they are marked as mandatory. |
POST Takes the json query and interprets it to run a query or api call
/api/objects/v1/businessplanning/interpreter
Interpret a JSON query to execute an underlying query or API request within the Business Planning administrative module.
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. |
|
|
Specify the unique identifier of the group plan associated with the query. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Provide the name of the target API to execute. |
|
|
Specify the classification or category of the query. |
|
|
Provide the name of the group associated with the query. |
|
|
List any specific system features required to execute this query. |
|
|
A detailed explanation describing the contents and purpose of the asset. |
|
|
The title or display name assigned to the asset. |
|
|
Specify the entity or target type affected by the query. |
|
|
Define the specific type or operation mode for the interpreter. |
|
|
Specify the identifier for the THQL query definition. |
|
|
Indicate whether the interpreter should return only a single value result. |
POST stripped down call to calculate a single formula from data passed in to substitute for variable names
/api/objects/v1/businessplanning/calculateFormula
Evaluate a single mathematical or logical formula using supplied data to replace variable placeholders.
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 |
|---|---|
|
|
Specify the formula expression to be evaluated. |
BusinessPlanning Member API (13)
POST Checks the THQL to see if it is valid and if so, write to the database
/prm/api/objects/v1/businessplanning/thqlvalidator
Validate a THQL query string and save it to the database if it conforms to required specifications.
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 THQL query string to validate and persist. |
POST Gets a list of requested Metrics containing the queryParameters but not the items this is in preparation for executing a list of metrics
/prm/api/objects/v1/businessplanning/getBPMetricsQueryParameters
Retrieve a list of query parameters for requested metrics in preparation for execution, excluding metric item details.
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. |
GET Gets the list of available custom json queries
/prm/api/objects/v1/businessplanning/customQueryList
Retrieve a list of all available custom JSON queries defined in the Business Planning module.
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 list of available json queries
/prm/api/objects/v1/businessplanning/defaultQueryList
Retrieve the default list of standard JSON queries configured for Business Planning.
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 the list of available partnership goals, i.e., non numeric objectives
/prm/api/objects/v1/businessplanning/getPartnershipGoalsByIds
Retrieve a collection of non-numeric partnership objectives and goals matching specified 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 (8)
|
Option Name |
Description |
|---|---|
|
|
Specify the updated display title for the assets. |
|
|
The category classification for the metric. |
|
|
Provide a comprehensive description of the assets and their contents. |
|
|
Specify the numeric sorting order used to position the assets in listings. |
|
|
The unique identifier of the custom metric. |
|
|
The title or description of the partnership goal. |
|
|
The number of days allowed to reach the goal deadline. |
|
|
The completion percentage of the goal. |
GET Gets the list of current Metrics for business plan this does NOT return the complete metric JSON
/prm/api/objects/v1/businessplanning/getBPPlanMetrics/{planId}
Retrieve the current active metrics for a specific business plan, omitting the full metric definition JSON.
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 business plan. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the list of current Template Metrics
/prm/api/objects/v1/businessplanning/getMetric/{metricName}
Retrieve current template metrics matching the specified metric name.
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 name of the metric to look up. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the list of current Template Metrics for Template display this does NOT return the complete metric JSON
/prm/api/objects/v1/businessplanning/getBPPlanMetricsWithTargets/{planId}
Retrieve current metrics alongside their associated targets for a given business plan, formatted for display without the full metric definition JSON.
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 business plan. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the list of current Template Metrics for Template display this does NOT return the complete metric JSON
/prm/api/objects/v1/businessplanning/getBPTemplateMetrics/{templateId}
Retrieve the current display metrics configured for a specific business plan template, excluding the full metric definition JSON.
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 business planning template. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets the list of custom metric data
/prm/api/objects/v1/businessplanning/getCustomMetricsByIds
Retrieve data for custom metrics that correspond to the provided list of 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 (11)
|
Option Name |
Description |
|---|---|
|
|
The API name of the custom metric. |
|
|
The category classification for the metric. |
|
|
The display group name to which the metric belongs. |
|
|
List of system feature keys required to support this metric. |
|
|
Provide a comprehensive description of the assets and their contents. |
|
|
Specify the numeric sorting order used to position the assets in listings. |
|
|
Indicates whether the metric represents a single value rather than a time series or multi-value set. |
|
|
The time period classification for setting the metric target, such as monthly or quarterly. |
|
|
The unit or target type applied to the metric. |
|
|
Indicates whether the metric is mandatory for the plan. |
|
|
The unique identifier of the custom metric. |
POST Gets the partnership goal from the bp partnership plan goal or bp partner ship goal depending on if it is an update or add.
/prm/api/objects/v1/businessplanning/getPartnerPlanGoals
Retrieve partnership goal records from either the plan goals or standard partnership goals based on whether the operation is an add or 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 response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Specifies whether the operation context is adding or updating a goal. |
|
|
The unique identifier of the business plan. |
|
|
The unique identifier of the business planning template. |
|
|
Filters goals based on whether they are marked as mandatory. |
POST Takes the json query and interprets it to run a query or api call
/prm/api/objects/v1/businessplanning/interpreter
Interpret a provided JSON query to execute a business planning query or API call.
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. |
|
|
Specify the unique identifier of the group plan associated with the query. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Provide the name of the target API to execute. |
|
|
Specify the classification or category of the query. |
|
|
Provide the name of the group associated with the query. |
|
|
List any specific system features required to execute this query. |
|
|
A detailed explanation describing the contents and purpose of the asset. |
|
|
The title or display name assigned to the asset. |
|
|
Specify the entity or target type affected by the query. |
|
|
Define the specific type or operation mode for the interpreter. |
|
|
Specify the identifier for the THQL query definition. |
|
|
Indicate whether the interpreter should return only a single value result. |
POST stripped down call to calculate a single formula from data passed in to substitute for variable names
/prm/api/objects/v1/businessplanning/calculateFormula
Evaluate a single formula by substituting variable names with values provided in the request data.
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 |
|---|---|
|
|
Specify the formula expression to be evaluated. |
CMSItem Admin API (4)
DELETE Deletes a single CMS Item by id.
/api/objects/v1/CMSItem/{id}
Permanently remove a single CMS item 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 CMS Items by id.
/api/objects/v1/CMSItem
Permanently delete multiple CMS items at once 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. |
PATCH Updates a single CMS Item based on the specified view model.
/api/objects/v1/CMSItem/{id}
Apply partial updates to an existing CMS item identified by its unique ID 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 CMS Items based on the specified view models.
/api/objects/v1/CMSItem
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. |
CMSItem Member API (4)
DELETE Deletes a single CMS Item by id.
/prm/api/objects/v1/CMSItem/{id}
Permanently remove a single CMS item by its unique identifier using member-level 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many CMS Items by id.
/prm/api/objects/v1/CMSItem
Permanently delete multiple CMS items at once using member-level 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single CMS Item based on the specified view model.
/prm/api/objects/v1/CMSItem/{id}
Apply partial updates to an existing CMS item identified by its unique ID using member-level 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. |
|
|
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 CMS Items based on the specified view models.
/prm/api/objects/v1/CMSItem
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. |
CMSPageEngagement Admin API (8)
PUT Adds a single or many CMS Page Engagements based on the specified view model(s).
/api/objects/v1/CMSPageEngagement
Create or replace one or more CMS page engagement 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 CMS Page Engagement by id.
/api/objects/v1/CMSPageEngagement/{id}
Permanently remove a specific CMS page engagement record by its ID 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 CMS Page Engagements by id.
/api/objects/v1/CMSPageEngagement
Permanently remove multiple CMS page engagement 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 list of account IDs to delete. |
POST Gets a list of CMS Page Engagements corresponding to the given data fields.
/api/objects/v1/CMSPageEngagement
Retrieve a list of CMS page engagement records matching filter criteria specified 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 CMS Page Engagements corresponding to the given parameters.
/api/objects/v1/CMSPageEngagement
Retrieve a list of CMS page engagement records matching 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 CMS Page Engagement by id.
/api/objects/v1/CMSPageEngagement/{id}
Retrieve details for a single CMS page engagement record by its unique ID 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 CMS Page Engagement based on the specified view model.
/api/objects/v1/CMSPageEngagement/{id}
Apply partial updates to an existing CMS page engagement record identified by its unique ID 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 CMS Page Engagements based on the specified view models.
/api/objects/v1/CMSPageEngagement
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. |
CMSPageEngagement Member API (8)
PUT Adds a single or many CMS Page Engagements based on the specified view model(s).
/prm/api/objects/v1/CMSPageEngagement
Create or replace one or more CMS page engagement records using member-level 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single CMS Page Engagement by id.
/prm/api/objects/v1/CMSPageEngagement/{id}
Permanently remove a specific CMS page engagement record by its ID using member-level 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many CMS Page Engagements by id.
/prm/api/objects/v1/CMSPageEngagement
Permanently remove multiple CMS page engagement records using member-level 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of CMS Page Engagements corresponding to the given data fields.
/prm/api/objects/v1/CMSPageEngagement
Retrieve a list of CMS page engagements matching specified data fields provided in the request body. Use this member-level action to query engagement records with complex search 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 CMS Page Engagements corresponding to the given parameters.
/prm/api/objects/v1/CMSPageEngagement
Retrieve a list of CMS page engagements matching the specified query parameters. Use this member-level action to search, paginate, or filter 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 CMS Page Engagement by id.
/prm/api/objects/v1/CMSPageEngagement/{id}
Retrieve details for a single CMS page engagement by its unique identifier. Use this member-level action to view specific engagement record data.
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 CMS Page Engagement based on the specified view model.
/prm/api/objects/v1/CMSPageEngagement/{id}
Update fields of an existing CMS page engagement record by its unique identifier. Use this member-level action to apply partial changes defined in 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 CMS Page Engagements based on the specified view models.
/prm/api/objects/v1/CMSPageEngagement
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. |
Calendar Admin API (3)
POST Gets a list of Calendars corresponding to the given data fields.
/api/objects/v1/Calendar
Retrieve a list of calendars matching criteria provided in the request body. Use this administrative action to run advanced searches on calendar 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 Calendars corresponding to the given parameters.
/api/objects/v1/Calendar
Retrieve a list of calendars filtered by query parameters. Use this administrative action to browse or search calendar configurations across the 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. |
|
|
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 Calendar by id.
/api/objects/v1/Calendar/{id}
Retrieve detailed information for a specific calendar by its unique identifier. Use this administrative action to view calendar settings 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). |
Calendar Member API (3)
POST Gets a list of Calendars corresponding to the given data fields.
/prm/api/objects/v1/Calendar
Retrieve a list of calendars matching data criteria specified in the request body. Use this member-level action to query available calendars.
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 Calendars corresponding to the given parameters.
/prm/api/objects/v1/Calendar
Retrieve a list of accessible calendars matching the given query parameters. Use this member-level action to filter or browse calendar entries.
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 Calendar by id.
/prm/api/objects/v1/Calendar/{id}
Retrieve the details of a specific calendar by its unique identifier. Use this member-level action to review individual calendar 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). |
CalendarEvent Admin API (8)
PUT Adds a single or many Calendar Events based on the specified view model(s).
/api/objects/v1/CalendarEvent
Add or update one or more calendar events using the specified view models. Use this administrative action to create new events or perform bulk updates.
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 Calendar Event by id.
/api/objects/v1/CalendarEvent/{id}
Permanently delete a single calendar event by its unique identifier. Use this administrative action to remove an individual event 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 many Calendar Events by id.
/api/objects/v1/CalendarEvent
Permanently delete multiple calendar events by their unique identifiers. Use this administrative action to perform bulk deletion of event 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 Calendar Events corresponding to the given data fields.
/api/objects/v1/CalendarEvent
Retrieve a list of calendar events matching data fields provided in the request body. Use this administrative action to execute complex event searches.
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 Calendar Events corresponding to the given parameters.
/api/objects/v1/CalendarEvent
Retrieve a list of calendar events filtered by query parameters. Use this administrative action to search and display scheduled events.
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 Calendar Event by id.
/api/objects/v1/CalendarEvent/{id}
Retrieve details for a specific calendar event by its unique identifier. Use this administrative action to inspect event schedules and properties.
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 Calendar Event based on the specified view model.
/api/objects/v1/CalendarEvent/{id}
Update specific properties of an existing calendar event by its unique identifier. Use this administrative action to apply partial modifications based on the 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 Calendar Events based on the specified view models.
/api/objects/v1/CalendarEvent
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. |
CalendarEvent Member API (8)
PUT Adds a single or many Calendar Events based on the specified view model(s).
/prm/api/objects/v1/CalendarEvent
Add or update one or more calendar events based on the specified view models. Use this member-level action to create or synchronize event entries.
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 Calendar Event by id.
/prm/api/objects/v1/CalendarEvent/{id}
Permanently delete a single calendar event by its unique identifier. Use this member-level action to remove an event entry.
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 Calendar Events by id.
/prm/api/objects/v1/CalendarEvent
Delete multiple calendar events in bulk 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 Calendar Events corresponding to the given data fields.
/prm/api/objects/v1/CalendarEvent
Retrieve a filtered list of calendar events matching criteria 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 Calendar Events corresponding to the given parameters.
/prm/api/objects/v1/CalendarEvent
Retrieve a list of calendar events 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 Calendar Event by id.
/prm/api/objects/v1/CalendarEvent/{id}
Retrieve details for a single calendar event by its 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). |
PATCH Updates a single Calendar Event based on the specified view model.
/prm/api/objects/v1/CalendarEvent/{id}
Update specific fields of an existing calendar event using the provided view model data.
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 Calendar Events based on the specified view models.
/prm/api/objects/v1/CalendarEvent
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. |
CobrandTemplate Admin API (3)
POST Gets a list of Co-branding Template corresponding to the given data fields.
/api/objects/v1/CobrandTemplate
Search and retrieve co-branding templates matching the criteria specified in the request body from an administrative 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 (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 corresponding to the given parameters.
/api/objects/v1/CobrandTemplate
Retrieve a list of co-branding templates matching query parameters 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. |
|
|
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 by id.
/api/objects/v1/CobrandTemplate/{id}
Retrieve the details of a specific co-branding template by its identifier 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
CobrandTemplate Member API (6)
GET /prm/api/objects/v1/CobrandTemplate/_getOrCreateAreaContent
/prm/api/objects/v1/CobrandTemplate/_getOrCreateAreaContent
Retrieve existing area content for a co-branding template or create it if it does not already 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 unique identifier of the asset to link to the playbooks. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/CobrandTemplate/_preview
/prm/api/objects/v1/CobrandTemplate/_preview
Generate and view a preview of a co-branding template.
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 asset to link to the playbooks. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/CobrandTemplate/_saveToPdf
/prm/api/objects/v1/CobrandTemplate/_saveToPdf
Export and save a co-branding template as a PDF document.
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 asset to link to the playbooks. |
|
|
Specifies the filename or title to assign to the generated PDF. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Co-branding Template corresponding to the given data fields.
/prm/api/objects/v1/CobrandTemplate
Search and retrieve co-branding templates matching criteria supplied in the request body for member users.
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 corresponding to the given parameters.
/prm/api/objects/v1/CobrandTemplate
Retrieve a list of co-branding templates matching the provided query parameters for member 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 Co-branding Template by id.
/prm/api/objects/v1/CobrandTemplate/{id}
Retrieve details for a specific co-branding template by its identifier for member 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
CobrandTemplateAreaContent Admin API (3)
POST Gets a list of Co-branding Template Area Content corresponding to the given data fields.
/api/objects/v1/CobrandTemplateAreaContent
Retrieve a list of co-branding template area content records matching 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 (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 Area Content corresponding to the given parameters.
/api/objects/v1/CobrandTemplateAreaContent
Retrieve co-branding template area content 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 Co-branding Template Area Content by id.
/api/objects/v1/CobrandTemplateAreaContent/{id}
Retrieve a single co-branding template area content record by its 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). |
CobrandTemplateAreaContent Member API (3)
POST Gets a list of Co-branding Template Area Content corresponding to the given data fields.
/prm/api/objects/v1/CobrandTemplateAreaContent
Retrieve a list of co-branding template area content records matching the filter criteria provided in the request body for member 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 Co-branding Template Area Content corresponding to the given parameters.
/prm/api/objects/v1/CobrandTemplateAreaContent
Retrieve a list of co-branding template area content records matching specified query parameters for member 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 Co-branding Template Area Content by id.
/prm/api/objects/v1/CobrandTemplateAreaContent/{id}
Retrieve a single co-branding template area content record by its unique identifier for member 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). |
CobrandedDocument Admin API (3)
POST Gets a list of Co-branded Document corresponding to the given data fields.
/api/objects/v1/CobrandedDocument
Retrieve a list of co-branded documents matching the filter criteria provided in the request body for administrative use.
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-branded Document corresponding to the given parameters.
/api/objects/v1/CobrandedDocument
Retrieve a list of co-branded documents matching specified query parameters for administrative use.
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-branded Document by id.
/api/objects/v1/CobrandedDocument/{id}
Retrieve a single co-branded document by its unique identifier for administrative use.
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). |
CobrandedDocument Member API (3)
POST Gets a list of Co-branded Document corresponding to the given data fields.
/prm/api/objects/v1/CobrandedDocument
Retrieve a list of co-branded documents matching the filter criteria provided in the request body for member 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 Co-branded Document corresponding to the given parameters.
/prm/api/objects/v1/CobrandedDocument
Retrieve a list of co-branded documents matching specified query parameters for member 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 Co-branded Document by id.
/prm/api/objects/v1/CobrandedDocument/{id}
Retrieve a single co-branded document by its unique identifier for member 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). |
Cobranding Admin API (4)
GET /api/objects/v1/cobranding/{id}
/api/objects/v1/cobranding/{id}
Retrieve administrative details for a specific co-branding configuration 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. |
|
|
The unique identifier of the account to view. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/cobranding/{id}/_fonts
/api/objects/v1/cobranding/{id}/_fonts
Retrieve font configurations and assets associated with a specific co-branding record for administrative use.
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. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/cobranding/{id}/_images
/api/objects/v1/cobranding/{id}/_images
Retrieve images and graphical assets associated with a specific co-branding record for administrative use.
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. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/cobranding/{id}/_text
/api/objects/v1/cobranding/{id}/_text
Retrieve text entries and field values associated with a specific co-branding record for administrative use.
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. |
|
|
The response format expected from the API (e.g. application/json). |
Cobranding Member API
GET /prm/api/objects/v1/cobranding/{id}
/prm/api/objects/v1/cobranding/{id}
Retrieve co-branding configuration details for a specific record by its unique identifier for member 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. |
|
|
The unique identifier of the account to view. |
|
|
The response format expected from the API (e.g. application/json). |
CompetencyClaimApprovalStatus Admin API (3)
POST Gets a list of Competency Claim Approval Status corresponding to the given data fields.
/api/objects/v1/CompetencyClaimApprovalStatus
Retrieve a list of competency claim approval statuses matching the filter criteria provided in the request body for administrative use.
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 Competency Claim Approval Status corresponding to the given parameters.
/api/objects/v1/CompetencyClaimApprovalStatus
Retrieve a list of competency claim approval statuses matching specified query parameters for administrative use.
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 Competency Claim Approval Status by id.
/api/objects/v1/CompetencyClaimApprovalStatus/{id}
Retrieve a single competency claim approval status record by its unique identifier for administrative use.
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). |
CompetencyClaimApprovalStatus Member API (3)
POST Gets a list of Competency Claim Approval Status corresponding to the given data fields.
/prm/api/objects/v1/CompetencyClaimApprovalStatus
Retrieve a list of competency claim approval statuses matching the filter criteria provided in the request body for member 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 Competency Claim Approval Status corresponding to the given parameters.
/prm/api/objects/v1/CompetencyClaimApprovalStatus
Retrieve a list of competency claim approval statuses matching the specified query criteria 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. |
|
|
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 Competency Claim Approval Status by id.
/prm/api/objects/v1/CompetencyClaimApprovalStatus/{id}
Retrieve the details of a single competency claim approval status by its unique identifier 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
CompetencyClaimNote Admin API (8)
PUT Adds a single or many Competency Claim Notes based on the specified view model(s).
/api/objects/v1/CompetencyClaimNote
Create one or more competency claim notes using the provided data models in the administrative interface.
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 Competency Claim Note by id.
/api/objects/v1/CompetencyClaimNote/{id}
Permanently delete a single competency claim note 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 Competency Claim Notes by id.
/api/objects/v1/CompetencyClaimNote
Permanently delete multiple competency claim notes specified in the 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 Competency Claim Notes corresponding to the given data fields.
/api/objects/v1/CompetencyClaimNote
Retrieve a list of competency claim notes matching the specified field values 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 Competency Claim Notes corresponding to the given parameters.
/api/objects/v1/CompetencyClaimNote
Retrieve a list of competency claim notes 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 Competency Claim Note by id.
/api/objects/v1/CompetencyClaimNote/{id}
Retrieve the details of a specific competency claim note 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). |
PATCH Updates a single Competency Claim Note based on the specified view model.
/api/objects/v1/CompetencyClaimNote/{id}
Partially update an existing competency claim note identified by its ID using the provided 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. |
|
|
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 Competency Claim Notes based on the specified view models.
/api/objects/v1/CompetencyClaimNote
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. |
CompetencyClaimNote Member API (8)
PUT Adds a single or many Competency Claim Notes based on the specified view model(s).
/prm/api/objects/v1/CompetencyClaimNote
Create one or more competency claim notes using the provided data models through the member portal.
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 Competency Claim Note by id.
/prm/api/objects/v1/CompetencyClaimNote/{id}
Permanently delete a single competency claim note by its unique identifier through 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Competency Claim Notes by id.
/prm/api/objects/v1/CompetencyClaimNote
Permanently delete multiple competency claim notes through the member portal.
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 Competency Claim Notes corresponding to the given data fields.
/prm/api/objects/v1/CompetencyClaimNote
Retrieve a list of competency claim notes matching the specified field filters in the request body through the member portal.
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 Competency Claim Notes corresponding to the given parameters.
/prm/api/objects/v1/CompetencyClaimNote
Retrieve a list of competency claim notes matching the specified query parameters through 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. |
|
|
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 Competency Claim Note by id.
/prm/api/objects/v1/CompetencyClaimNote/{id}
Retrieve the details of a single competency claim note by its unique identifier through 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Competency Claim Note based on the specified view model.
/prm/api/objects/v1/CompetencyClaimNote/{id}
Partially update an existing competency claim note identified by its ID through the member portal.
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 Competency Claim Notes based on the specified view models.
/prm/api/objects/v1/CompetencyClaimNote
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. |
Country Admin API (4)
GET /api/objects/v1/Country/_settings
/api/objects/v1/Country/_settings
Retrieve object settings and configuration metadata for the Country object in the administrative interface.
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 Countries corresponding to the given data fields.
/api/objects/v1/Country
Retrieve a list of countries matching the field values provided 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 Countries corresponding to the given parameters.
/api/objects/v1/Country
Retrieve a list of countries 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 Country by id.
/api/objects/v1/Country/{id}
Retrieve the details of a specific country 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). |
Country Member API
GET /prm/api/objects/v1/Country/_settings
/prm/api/objects/v1/Country/_settings
Retrieve object settings and configuration metadata for the Country object through 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 response format expected from the API (e.g. application/json). |