Version 1.0
Connector Overview: This page documents all 650 actions for the Impartnerconnector v1.0.
MPPartnerListingEngagement Member API (2)
PATCH Updates a single MP Partner Listing Engagement based on the specified view model.
/prm/api/objects/v1/MPPartnerListingEngagement/{id}
Update an existing MP partner listing engagement record using the provided view model. Use this in member contexts to apply partial changes to an engagement.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/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 MP Partner Listing Engagements based on the specified view models.
/prm/api/objects/v1/MPPartnerListingEngagement
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. |
MPPartnerListingNote Admin API (8)
PUT Adds a single or many MP Partner Listing Notes based on the specified view model(s).
/api/objects/v1/MPPartnerListingNote
Create or update one or more MP partner listing notes using the specified view models. Use this in administrative workflows to insert or overwrite note records individually or in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Partner Listing Note by id.
/api/objects/v1/MPPartnerListingNote/{id}
Permanently delete a single MP partner listing note by its unique ID. Use this in administrative workflows to remove an individual note 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 MP Partner Listing Notes by id.
/api/objects/v1/MPPartnerListingNote
Permanently delete multiple MP partner listing notes by their IDs. Use this in administrative workflows to remove notes 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 Gets a list of MP Partner Listing Notes corresponding to the given data fields.
/api/objects/v1/MPPartnerListingNote
Retrieve a list of MP partner listing notes matching the specified data fields in the request body. Use this in administrative workflows to search notes using complex field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Partner Listing Notes corresponding to the given parameters.
/api/objects/v1/MPPartnerListingNote
Retrieve a list of MP partner listing notes matching the specified query parameters. Use this in administrative workflows to query or browse note 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 MP Partner Listing Note by id.
/api/objects/v1/MPPartnerListingNote/{id}
Retrieve the details of a single MP partner listing note by its unique ID. Use this in administrative workflows to inspect a specific note record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Partner Listing Note based on the specified view model.
/api/objects/v1/MPPartnerListingNote/{id}
Update fields of a single MP partner listing note based on the specified view model. Use this in administrative workflows to apply partial updates to a 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 MP Partner Listing Notes based on the specified view models.
/api/objects/v1/MPPartnerListingNote
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. |
MPPartnerListingNote Member API (8)
PUT Adds a single or many MP Partner Listing Notes based on the specified view model(s).
/prm/api/objects/v1/MPPartnerListingNote
Create or update one or more MP partner listing notes using the specified view models. Use this in member contexts to insert or overwrite note records individually or in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Partner Listing Note by id.
/prm/api/objects/v1/MPPartnerListingNote/{id}
Permanently delete a single MP partner listing note by its unique ID. Use this in member contexts to remove an individual note 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 MP Partner Listing Notes by id.
/prm/api/objects/v1/MPPartnerListingNote
Permanently delete multiple MP partner listing notes by their IDs. Use this in member contexts to batch delete unwanted note 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 MP Partner Listing Notes corresponding to the given data fields.
/prm/api/objects/v1/MPPartnerListingNote
Retrieve a list of MP partner listing notes matching the specified data fields in the request body. Use this in member contexts to search notes 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 MP Partner Listing Notes corresponding to the given parameters.
/prm/api/objects/v1/MPPartnerListingNote
Retrieve a list of MP partner listing notes matching the specified query parameters. Use this in member contexts to filter and browse note 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 MP Partner Listing Note by id.
/prm/api/objects/v1/MPPartnerListingNote/{id}
Retrieve the details of a single MP partner listing note by its unique ID. Use this in member contexts to inspect a specific note record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Partner Listing Note based on the specified view model.
/prm/api/objects/v1/MPPartnerListingNote/{id}
Update fields of a single MP partner listing note based on the specified view model. Use this in member contexts to apply partial updates to an existing 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 MP Partner Listing Notes based on the specified view models.
/prm/api/objects/v1/MPPartnerListingNote
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. |
MPPartnerListingRequestNote Admin API (8)
PUT Adds a single or many MP Partner Listing Request Notes based on the specified view model(s).
/api/objects/v1/MPPartnerListingRequestNote
Create or update one or more MP partner listing request notes using the specified view models. Use this in administrative workflows to insert or overwrite request note records individually or in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Partner Listing Request Note by id.
/api/objects/v1/MPPartnerListingRequestNote/{id}
Permanently delete an individual MP partner listing request note using its identifier through the admin 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Partner Listing Request Notes by id.
/api/objects/v1/MPPartnerListingRequestNote
Permanently delete multiple MP partner listing request notes at once by their identifiers via the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Partner Listing Request Notes corresponding to the given data fields.
/api/objects/v1/MPPartnerListingRequestNote
Retrieve a list of MP partner listing request notes matching specified criteria submitted in the request body using admin 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 MP Partner Listing Request Notes corresponding to the given parameters.
/api/objects/v1/MPPartnerListingRequestNote
Retrieve a filtered list of MP partner listing request notes based on query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Partner Listing Request Note by id.
/api/objects/v1/MPPartnerListingRequestNote/{id}
Retrieve the details of a single MP partner listing request note by its unique identifier through the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Partner Listing Request Note based on the specified view model.
/api/objects/v1/MPPartnerListingRequestNote/{id}
Apply partial updates to an existing MP partner listing request note by identifier via the admin 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. |
|
|
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 MP Partner Listing Request Notes based on the specified view models.
/api/objects/v1/MPPartnerListingRequestNote
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. |
MPPartnerListingRequestNote Member API (8)
PUT Adds a single or many MP Partner Listing Request Notes based on the specified view model(s).
/prm/api/objects/v1/MPPartnerListingRequestNote
Create or replace one or more MP partner listing request notes 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 view model payload containing account details to add. |
DELETE Deletes a single MP Partner Listing Request Note by id.
/prm/api/objects/v1/MPPartnerListingRequestNote/{id}
Permanently delete a specific MP partner listing request note by its identifier using 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 MP Partner Listing Request Notes by id.
/prm/api/objects/v1/MPPartnerListingRequestNote
Permanently delete multiple MP partner listing request notes by id via the member 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 list of account IDs to delete. |
POST Gets a list of MP Partner Listing Request Notes corresponding to the given data fields.
/prm/api/objects/v1/MPPartnerListingRequestNote
Search and retrieve MP partner listing request notes matching specific criteria provided in the request body 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 (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 MP Partner Listing Request Notes corresponding to the given parameters.
/prm/api/objects/v1/MPPartnerListingRequestNote
Retrieve a list of MP partner listing request notes matching specified query parameters using 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 MP Partner Listing Request Note by id.
/prm/api/objects/v1/MPPartnerListingRequestNote/{id}
Retrieve details of a single MP partner listing request note using 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). |
PATCH Updates a single MP Partner Listing Request Note based on the specified view model.
/prm/api/objects/v1/MPPartnerListingRequestNote/{id}
Update specific fields of an existing MP partner listing request note by its identifier using 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 MP Partner Listing Request Notes based on the specified view models.
/prm/api/objects/v1/MPPartnerListingRequestNote
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. |
MPRequestConfig Admin API (8)
PUT Adds a single or many MP Request Configs based on the specified view model(s).
/api/objects/v1/MPRequestConfig
Create or replace one or more MP request configurations 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 view model payload containing account details to add. |
DELETE Deletes a single MP Request Config by id.
/api/objects/v1/MPRequestConfig/{id}
Permanently delete a specific MP request configuration by its unique identifier using admin 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 MP Request Configs by id.
/api/objects/v1/MPRequestConfig
Permanently delete multiple MP request configurations by their identifiers through the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Request Configs corresponding to the given data fields.
/api/objects/v1/MPRequestConfig
Retrieve a list of MP request configurations matching criteria provided in the request body via the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Request Configs corresponding to the given parameters.
/api/objects/v1/MPRequestConfig
Retrieve a collection of MP request configurations filtered by query parameters through the admin 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. |
|
|
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 MP Request Config by id.
/api/objects/v1/MPRequestConfig/{id}
Retrieve the configuration details for a single MP request configuration by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Request Config based on the specified view model.
/api/objects/v1/MPRequestConfig/{id}
Update specific attributes of an existing MP request configuration by identifier through the admin 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. |
|
|
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 MP Request Configs based on the specified view models.
/api/objects/v1/MPRequestConfig
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. |
MPRequestConfig Member API (8)
PUT Adds a single or many MP Request Configs based on the specified view model(s).
/prm/api/objects/v1/MPRequestConfig
Create one or multiple MP Request Config 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 MP Request Config by id.
/prm/api/objects/v1/MPRequestConfig/{id}
Permanently remove a specific MP Request Config 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 MP Request Configs by id.
/prm/api/objects/v1/MPRequestConfig
Permanently remove multiple MP Request Config records matching the 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Request Configs corresponding to the given data fields.
/prm/api/objects/v1/MPRequestConfig
Retrieve a filtered collection of MP Request Config records based on the submitted 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 MP Request Configs corresponding to the given parameters.
/prm/api/objects/v1/MPRequestConfig
Retrieve a list of MP Request Config records 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 single MP Request Config by id.
/prm/api/objects/v1/MPRequestConfig/{id}
Retrieve details for a single MP Request Config 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). |
PATCH Updates a single MP Request Config based on the specified view model.
/prm/api/objects/v1/MPRequestConfig/{id}
Update specific fields of an existing MP Request Config 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 MP Request Configs based on the specified view models.
/prm/api/objects/v1/MPRequestConfig
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. |
MPSearchEngagement Admin API (8)
PUT Adds a single or many MP Search Engagements based on the specified view model(s).
/api/objects/v1/MPSearchEngagement
Create one or multiple MP Search Engagement records with administrative privileges 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 MP Search Engagement by id.
/api/objects/v1/MPSearchEngagement/{id}
Permanently delete an MP Search Engagement record by its identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Search Engagements by id.
/api/objects/v1/MPSearchEngagement
Permanently delete multiple MP Search Engagement records by their identifiers 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 MP Search Engagements corresponding to the given data fields.
/api/objects/v1/MPSearchEngagement
Retrieve a list of MP Search Engagement records matching the submitted criteria via administrative search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Search Engagements corresponding to the given parameters.
/api/objects/v1/MPSearchEngagement
Retrieve a list of MP Search Engagement records filtered by the supplied parameters with 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 MP Search Engagement by id.
/api/objects/v1/MPSearchEngagement/{id}
Retrieve details for an individual MP Search Engagement by its ID using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Search Engagement based on the specified view model.
/api/objects/v1/MPSearchEngagement/{id}
Update attributes of a single MP Search Engagement record by 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 MP Search Engagements based on the specified view models.
/api/objects/v1/MPSearchEngagement
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. |
MPSearchEngagement Member API (8)
PUT Adds a single or many MP Search Engagements based on the specified view model(s).
/prm/api/objects/v1/MPSearchEngagement
Create one or multiple MP Search Engagement records as a member 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 MP Search Engagement by id.
/prm/api/objects/v1/MPSearchEngagement/{id}
Permanently delete a single MP Search Engagement record by its identifier on behalf of a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Search Engagements by id.
/prm/api/objects/v1/MPSearchEngagement
Permanently delete multiple MP Search Engagement records by their identifiers 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. |
|
|
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 MP Search Engagements corresponding to the given data fields.
/prm/api/objects/v1/MPSearchEngagement
Retrieve a collection of MP Search Engagement records that match the provided data field criteria 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. |
|
|
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 MP Search Engagements corresponding to the given parameters.
/prm/api/objects/v1/MPSearchEngagement
Retrieve a list of marketplace search engagements accessible 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 MP Search Engagement by id.
/prm/api/objects/v1/MPSearchEngagement/{id}
Retrieve details for a specific marketplace search engagement 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 MP Search Engagement based on the specified view model.
/prm/api/objects/v1/MPSearchEngagement/{id}
Update specific fields of an existing marketplace search engagement 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 MP Search Engagements based on the specified view models.
/prm/api/objects/v1/MPSearchEngagement
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. |
MPSolutionContact Admin API (11)
PUT Adds a single or many MP Solution Contacts based on the specified view model(s).
/api/objects/v1/MPSolutionContact
Create or update one or multiple marketplace solution contact 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 MP Solution Contact by id.
/api/objects/v1/MPSolutionContact/{id}
Permanently remove a single marketplace solution contact 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 MP Solution Contacts by id.
/api/objects/v1/MPSolutionContact
Permanently delete multiple marketplace solution contacts 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 MP Solution Contacts based on the given data fields.
/api/objects/v1/MPSolutionContact/_export
Export marketplace solution contact records matching data filter 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 (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 MP Solution Contacts based on the same get parameters.
/api/objects/v1/MPSolutionContact/_export
Export marketplace solution contact records using URL query filter parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of MP Solution Contacts corresponding to the given data fields.
/api/objects/v1/MPSolutionContact
Retrieve a list of marketplace solution contact records matching the criteria specified in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Solution Contacts corresponding to the given parameters.
/api/objects/v1/MPSolutionContact
Retrieve a list of marketplace solution contact records matching the provided 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 MP Solution Contact by id.
/api/objects/v1/MPSolutionContact/{id}
Retrieve details for a single marketplace solution contact 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 MP Solution Contact.
/api/objects/v1/MPSolutionContact/_export/types
Retrieve the supported export formats and types available for marketplace solution contacts.
Parameters
|
Parameter Name |
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 MP Solution Contact based on the specified view model.
/api/objects/v1/MPSolutionContact/{id}
Update specified fields of a single marketplace solution contact 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 MP Solution Contacts based on the specified view models.
/api/objects/v1/MPSolutionContact
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. |
MPSolutionContact Member API (11)
PUT Adds a single or many MP Solution Contacts based on the specified view model(s).
/prm/api/objects/v1/MPSolutionContact
Create or update one or multiple marketplace solution contacts via the member portal 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 MP Solution Contact by id.
/prm/api/objects/v1/MPSolutionContact/{id}
Permanently remove a single marketplace solution contact by its unique identifier using 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Solution Contacts by id.
/prm/api/objects/v1/MPSolutionContact
Permanently delete multiple marketplace solution contacts in bulk using 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the MP Solution Contacts based on the given data fields.
/prm/api/objects/v1/MPSolutionContact/_export
Export marketplace solution contact records accessible to the member based on data 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 MP Solution Contacts based on the same get parameters.
/prm/api/objects/v1/MPSolutionContact/_export
Export marketplace solution contact records accessible to the member using 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 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 MP Solution Contacts corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionContact
Retrieve a list of MP Solution Contacts matching the specified 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 MP Solution Contacts corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionContact
Retrieve a list of MP Solution Contacts 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 MP Solution Contact by id.
/prm/api/objects/v1/MPSolutionContact/{id}
Retrieve the details of a single MP Solution Contact 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 MP Solution Contact.
/prm/api/objects/v1/MPSolutionContact/_export/types
Retrieve the supported export formats and types available for MP Solution Contact records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Solution Contact based on the specified view model.
/prm/api/objects/v1/MPSolutionContact/{id}
Update specific fields of an existing MP Solution Contact 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 MP Solution Contacts based on the specified view models.
/prm/api/objects/v1/MPSolutionContact
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. |
MPSolutionContactNote Admin API (8)
PUT Adds a single or many MP Solution Contact Notes based on the specified view model(s).
/api/objects/v1/MPSolutionContactNote
Create or update one or more MP Solution Contact Notes 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 MP Solution Contact Note by id.
/api/objects/v1/MPSolutionContactNote/{id}
Permanently delete a specific MP Solution Contact Note 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 MP Solution Contact Notes by id.
/api/objects/v1/MPSolutionContactNote
Permanently delete multiple MP Solution Contact Notes in a single administrative operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Solution Contact Notes corresponding to the given data fields.
/api/objects/v1/MPSolutionContactNote
Retrieve a list of MP Solution Contact Notes matching the specified data fields using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Solution Contact Notes corresponding to the given parameters.
/api/objects/v1/MPSolutionContactNote
Retrieve a list of MP Solution Contact Notes 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 MP Solution Contact Note by id.
/api/objects/v1/MPSolutionContactNote/{id}
Retrieve a specific MP Solution Contact Note 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 MP Solution Contact Note based on the specified view model.
/api/objects/v1/MPSolutionContactNote/{id}
Update an existing MP Solution Contact Note 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 MP Solution Contact Notes based on the specified view models.
/api/objects/v1/MPSolutionContactNote
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. |
MPSolutionContactNote Member API (8)
PUT Adds a single or many MP Solution Contact Notes based on the specified view model(s).
/prm/api/objects/v1/MPSolutionContactNote
Create or update one or more MP Solution Contact Notes as a portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Solution Contact Note by id.
/prm/api/objects/v1/MPSolutionContactNote/{id}
Permanently delete a specific MP Solution Contact Note by its unique identifier as 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Solution Contact Notes by id.
/prm/api/objects/v1/MPSolutionContactNote
Permanently delete multiple MP Solution Contact Notes in bulk as a portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Solution Contact Notes corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionContactNote
Retrieve a list of MP Solution Contact Notes matching the specified data fields as a portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (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 MP Solution Contact Notes corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionContactNote
Retrieve a list of MP Solution Contact Notes filtered by query parameters as 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. |
|
|
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 MP Solution Contact Note by id.
/prm/api/objects/v1/MPSolutionContactNote/{id}
Retrieve the details of a single MP Solution Contact Note by its unique identifier as 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). |
PATCH Updates a single MP Solution Contact Note based on the specified view model.
/prm/api/objects/v1/MPSolutionContactNote/{id}
Update specific fields of an existing MP Solution Contact Note by its unique identifier as a portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 MP Solution Contact Notes based on the specified view models.
/prm/api/objects/v1/MPSolutionContactNote
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. |
MPSolutionListing Admin API (13)
GET /api/objects/v1/MPSolutionListing/_view
/api/objects/v1/MPSolutionListing/_view
Retrieve a view representation of MP Solution Listings using administrative privileges. Use this action to search, filter, and sort listings according to customized view criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify a search query string to find matching MP Solution Listings. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
Define filter expressions to restrict which MP Solution Listings are returned. |
|
|
Specify field names and sort directions to control the ordering of the returned listings. |
|
|
Specify the number of partner records to skip before returning results. |
|
|
Specify the maximum number of partner records to return. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/MPSolutionListing/{id}/_view
/api/objects/v1/MPSolutionListing/{id}/_view
Retrieve a specific MP Solution Listing view representation by its identifier using administrative permissions. Use it to inspect formatted view details for an individual listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 MP Solution Listings based on the specified view model(s).
/api/objects/v1/MPSolutionListing
Create or replace one or multiple MP Solution Listings using view models with admin access. Use this action when importing or bulk updating listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Solution Listing by id.
/api/objects/v1/MPSolutionListing/{id}
Permanently delete a specific MP Solution 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 MP Solution Listings by id.
/api/objects/v1/MPSolutionListing
Delete multiple MP Solution Listings simultaneously by providing their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the MP Solution Listings based on the given data fields.
/api/objects/v1/MPSolutionListing/_export
Export MP Solution Listings based on provided data fields using a request payload. Use this action to generate targeted data export files via admin 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 (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 MP Solution Listings based on the same get parameters.
/api/objects/v1/MPSolutionListing/_export
Export MP Solution Listings based on configured query parameters using administrative privileges. Use this action to trigger an export matching specific criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of MP Solution Listings corresponding to the given data fields.
/api/objects/v1/MPSolutionListing
Retrieve a list of MP Solution Listings matching criteria specified in the request body. Use this action when filter parameters exceed typical 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 MP Solution Listings corresponding to the given parameters.
/api/objects/v1/MPSolutionListing
Retrieve a list of MP Solution Listings using administrative query parameters. Use this action to browse or inspect existing solution listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Solution Listing by id.
/api/objects/v1/MPSolutionListing/{id}
Retrieve details of a single MP Solution 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 MP Solution Listing.
/api/objects/v1/MPSolutionListing/_export/types
Retrieve a list of supported export file types and formats available for MP Solution 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 MP Solution Listing based on the specified view model.
/api/objects/v1/MPSolutionListing/{id}
Update specific fields of an existing MP Solution Listing by its identifier using an admin 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 MP Solution Listings based on the specified view models.
/api/objects/v1/MPSolutionListing
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. |
MPSolutionListing Member API (13)
GET /prm/api/objects/v1/MPSolutionListing/_view
/prm/api/objects/v1/MPSolutionListing/_view
Retrieve a view representation of MP Solution Listings via the member API. Use this action to search, filter, and order listings 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. |
|
|
Specify a text query to search across member-accessible MP Solution Listings. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
Define filtering conditions to narrow down the returned MP Solution Listings. |
|
|
Specify fields and sort order to arrange the returned MP Solution Listings. |
|
|
Specify the number of partner records to skip before returning results. |
|
|
Specify the maximum number of partner records to return. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/MPSolutionListing/{id}/_view
/prm/api/objects/v1/MPSolutionListing/{id}/_view
Retrieve a single MP Solution Listing view representation by its 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. |
|
|
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 MP Solution Listings based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListing
Create or update one or more MP Solution Listings from a member account based on specified 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 MP Solution Listing by id.
/prm/api/objects/v1/MPSolutionListing/{id}
Delete an individual MP Solution Listing by identifier using member credentials.
Parameters
|
Parameter Name |
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 MP Solution Listings by id.
/prm/api/objects/v1/MPSolutionListing
Delete multiple marketplace solution listings by their identifiers. Use this action to batch remove solution listings 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. |
|
|
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 MP Solution Listings based on the given data fields.
/prm/api/objects/v1/MPSolutionListing/_export
Export marketplace solution listings matching the criteria provided in the request payload. Use this action to generate an export when filtering 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 (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 MP Solution Listings based on the same get parameters.
/prm/api/objects/v1/MPSolutionListing/_export
Export marketplace solution listings using query parameters. Use this action to download solution listing records matching the specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of MP Solution Listings corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListing
Retrieve a list of marketplace solution listings filtered by criteria supplied in the request body. Use this action to query member-accessible solution listings with complex field filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Solution Listings corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListing
Retrieve a list of marketplace solution listings based on specified query parameters. Use this action to view member-accessible solution listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Solution Listing by id.
/prm/api/objects/v1/MPSolutionListing/{id}
Retrieve the details of a single marketplace solution listing by its identifier. Use this action to inspect a specific solution listing for a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 MP Solution Listing.
/prm/api/objects/v1/MPSolutionListing/_export/types
Retrieve the available file formats and types for exporting marketplace solution listings. Use this action to check supported export formats before requesting 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 MP Solution Listing based on the specified view model.
/prm/api/objects/v1/MPSolutionListing/{id}
Update an existing marketplace solution listing using the provided fields. Use this action to modify solution listing details for 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 MP Solution Listings based on the specified view models.
/prm/api/objects/v1/MPSolutionListing
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. |
MPSolutionListingEngagement Admin API (8)
PUT Adds a single or many MP Solution Listing Engagements based on the specified view model(s).
/api/objects/v1/MPSolutionListingEngagement
Create or replace one or more marketplace solution listing engagements with administrative privileges. Use this action to bulk record or update engagement data across solution listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Solution Listing Engagement by id.
/api/objects/v1/MPSolutionListingEngagement/{id}
Permanently delete a specific marketplace solution listing engagement by its identifier using administrative privileges. Use this action when an individual engagement record needs to be removed.
Parameters
|
Parameter Name |
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 MP Solution Listing Engagements by id.
/api/objects/v1/MPSolutionListingEngagement
Delete multiple marketplace solution listing engagements by their identifiers using administrative privileges. Use this action to batch remove engagement 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 MP Solution Listing Engagements corresponding to the given data fields.
/api/objects/v1/MPSolutionListingEngagement
Retrieve marketplace solution listing engagements matching the filter criteria supplied in the request body with administrative privileges. Use this action to search engagement records across complex data conditions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Engagements corresponding to the given parameters.
/api/objects/v1/MPSolutionListingEngagement
Retrieve a list of marketplace solution listing engagements matching the specified query parameters using administrative privileges. Use this action to browse or audit 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 MP Solution Listing Engagement by id.
/api/objects/v1/MPSolutionListingEngagement/{id}
Retrieve the details of a single marketplace solution listing engagement by its identifier with administrative privileges. Use this action to inspect an engagement record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Solution Listing Engagement based on the specified view model.
/api/objects/v1/MPSolutionListingEngagement/{id}
Update fields on an existing marketplace solution listing engagement using administrative privileges. Use this action to modify engagement details 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. |
|
|
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 MP Solution Listing Engagements based on the specified view models.
/api/objects/v1/MPSolutionListingEngagement
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. |
MPSolutionListingEngagement Member API (8)
PUT Adds a single or many MP Solution Listing Engagements based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingEngagement
Create or replace one or more marketplace solution listing engagements on behalf of a member. Use this action to record or refresh engagement activity for member listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Solution Listing Engagement by id.
/prm/api/objects/v1/MPSolutionListingEngagement/{id}
Permanently delete a single marketplace solution listing engagement by its identifier on behalf of a member. Use this action to remove an individual engagement record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Solution Listing Engagements by id.
/prm/api/objects/v1/MPSolutionListingEngagement
Delete multiple marketplace solution listing engagements by their identifiers on behalf of a member. Use this action to batch remove engagement 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 MP Solution Listing Engagements corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingEngagement
Retrieve a list of marketplace solution listing engagements matching the filter criteria 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 MP Solution Listing Engagements corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingEngagement
Retrieve a list of marketplace solution listing 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 MP Solution Listing Engagement by id.
/prm/api/objects/v1/MPSolutionListingEngagement/{id}
Retrieve details of a single marketplace solution listing 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 MP Solution Listing Engagement based on the specified view model.
/prm/api/objects/v1/MPSolutionListingEngagement/{id}
Update specific fields of an existing marketplace solution listing engagement 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 MP Solution Listing Engagements based on the specified view models.
/prm/api/objects/v1/MPSolutionListingEngagement
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. |
MPSolutionListingItem Admin API (11)
PUT Adds a single or many MP Solution Listing Items based on the specified view model(s).
/api/objects/v1/MPSolutionListingItem
Create or replace one or more marketplace solution listing items 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 MP Solution Listing Item by id.
/api/objects/v1/MPSolutionListingItem/{id}
Permanently remove a single marketplace solution listing 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 MP Solution Listing Items by id.
/api/objects/v1/MPSolutionListingItem
Permanently remove multiple marketplace solution listing items 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 MP Solution Listing Items based on the given data fields.
/api/objects/v1/MPSolutionListingItem/_export
Export marketplace solution listing items matching the 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 (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 MP Solution Listing Items based on the same get parameters.
/api/objects/v1/MPSolutionListingItem/_export
Export marketplace solution listing items matching the 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 MP Solution Listing Items corresponding to the given data fields.
/api/objects/v1/MPSolutionListingItem
Retrieve a list of marketplace solution listing items corresponding to the data fields 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 MP Solution Listing Items corresponding to the given parameters.
/api/objects/v1/MPSolutionListingItem
Retrieve a list of marketplace solution listing items 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 MP Solution Listing Item by id.
/api/objects/v1/MPSolutionListingItem/{id}
Retrieve details of a single marketplace solution listing 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 |
|
|
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 MP Solution Listing Item.
/api/objects/v1/MPSolutionListingItem/_export/types
Retrieve the available export file formats and types for marketplace solution listing 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. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Solution Listing Item based on the specified view model.
/api/objects/v1/MPSolutionListingItem/{id}
Update specific fields of an existing marketplace solution listing item 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 MP Solution Listing Items based on the specified view models.
/api/objects/v1/MPSolutionListingItem
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. |
MPSolutionListingItem Member API (11)
PUT Adds a single or many MP Solution Listing Items based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingItem
Create or replace one or more marketplace solution listing items through the member 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 MP Solution Listing Item by id.
/prm/api/objects/v1/MPSolutionListingItem/{id}
Permanently remove a single marketplace solution listing item by its unique identifier through the member 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Solution Listing Items by id.
/prm/api/objects/v1/MPSolutionListingItem
Permanently remove multiple marketplace solution listing items in bulk through the member 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 list of account IDs to delete. |
POST Exports the MP Solution Listing Items based on the given data fields.
/prm/api/objects/v1/MPSolutionListingItem/_export
Export MP Solution Listing Items based on the provided filter and field definitions. Use this action to generate an export file containing member listing item 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 (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 MP Solution Listing Items based on the same get parameters.
/prm/api/objects/v1/MPSolutionListingItem/_export
Export MP Solution Listing Items based on query parameters. Use this action to produce an export file of member listing items using URL-based filter criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of MP Solution Listing Items corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingItem
Retrieve a list of MP Solution Listing Items matching criteria provided in the request payload. Use this action when searching member listing items with complex filter 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 (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 MP Solution Listing Items corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingItem
Retrieve a list of MP Solution Listing Items matching the provided query parameters. Use this action to browse or filter member listing 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 MP Solution Listing Item by id.
/prm/api/objects/v1/MPSolutionListingItem/{id}
Retrieve a single MP Solution Listing Item by its unique identifier. Use this action to inspect the full details of a specific member listing item.
Parameters
|
Parameter Name |
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 MP Solution Listing Item.
/prm/api/objects/v1/MPSolutionListingItem/_export/types
Retrieve the available export file formats and types for MP Solution Listing Items. Use this action to determine supported export configurations prior to running 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 MP Solution Listing Item based on the specified view model.
/prm/api/objects/v1/MPSolutionListingItem/{id}
Update specified fields on an existing MP Solution Listing Item by its unique identifier. Use this action to modify member listing item properties without replacing the entire resource.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/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 MP Solution Listing Items based on the specified view models.
/prm/api/objects/v1/MPSolutionListingItem
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. |
MPSolutionListingItemAttachment Admin API (11)
PUT Adds a single or many MP Solution Listing Item Attachments based on the specified view model(s).
/api/objects/v1/MPSolutionListingItemAttachment
Create or replace one or more MP Solution Listing Item Attachments. Use this action to upload or overwrite attachment records for marketplace solution listing items.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Item Attachment by id.
/api/objects/v1/MPSolutionListingItemAttachment/{id}
Permanently delete a single MP Solution Listing Item 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 MP Solution Listing Item Attachments by id.
/api/objects/v1/MPSolutionListingItemAttachment
Permanently delete multiple MP Solution Listing Item Attachments in a single operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the MP Solution Listing Item Attachments based on the given data fields.
/api/objects/v1/MPSolutionListingItemAttachment/_export
Export MP Solution Listing Item Attachments based on data fields provided in the request payload. Use this action to generate an export file of attachments matching complex filter 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 (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 MP Solution Listing Item Attachments based on the same get parameters.
/api/objects/v1/MPSolutionListingItemAttachment/_export
Export MP Solution Listing Item Attachments matching URL query parameters. Use this action to produce an export file of attachments using standard filter parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of MP Solution Listing Item Attachments corresponding to the given data fields.
/api/objects/v1/MPSolutionListingItemAttachment
Retrieve a list of MP Solution Listing Item Attachments matching criteria provided in the request payload. Use this action when filtering attachments using complex 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 MP Solution Listing Item Attachments corresponding to the given parameters.
/api/objects/v1/MPSolutionListingItemAttachment
Retrieve a list of MP Solution Listing Item Attachments matching the provided query parameters. Use this action to browse and filter attachment records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Solution Listing Item Attachment by id.
/api/objects/v1/MPSolutionListingItemAttachment/{id}
Retrieve a single MP Solution Listing Item Attachment by its unique identifier. Use this action to view metadata and details for a specific attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
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 MP Solution Listing Item Attachment.
/api/objects/v1/MPSolutionListingItemAttachment/_export/types
Retrieve the available export file formats and types for MP Solution Listing Item Attachments. Use this action to check supported export options before initiating an export.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Solution Listing Item Attachment based on the specified view model.
/api/objects/v1/MPSolutionListingItemAttachment/{id}
Update specified fields on an existing MP Solution Listing Item Attachment by its unique identifier. Use this action to modify attachment details 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 MP Solution Listing Item Attachments based on the specified view models.
/api/objects/v1/MPSolutionListingItemAttachment
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. |
MPSolutionListingItemAttachment Member API (11)
PUT Adds a single or many MP Solution Listing Item Attachments based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingItemAttachment
Create one or more marketplace solution listing item attachments using the member portal API. Use this action to upload and link new attachment records 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Solution Listing Item Attachment by id.
/prm/api/objects/v1/MPSolutionListingItemAttachment/{id}
Delete a specific marketplace solution listing item attachment by its unique identifier. Use this action to remove an individual attachment record via the member portal 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 MP Solution Listing Item Attachments by id.
/prm/api/objects/v1/MPSolutionListingItemAttachment
Delete multiple marketplace solution listing item attachments simultaneously by their identifiers. Use this action to batch-remove attachment records via the member portal 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 MP Solution Listing Item Attachments based on the given data fields.
/prm/api/objects/v1/MPSolutionListingItemAttachment/_export
Export marketplace solution listing item attachments matching the filter criteria provided in the request payload. Use this action when exporting attachment records that require complex search field 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 (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 MP Solution Listing Item Attachments based on the same get parameters.
/prm/api/objects/v1/MPSolutionListingItemAttachment/_export
Export marketplace solution listing item attachments using URL query parameters. Use this action to extract attachment records into an export format supported by the member portal 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 MP Solution Listing Item Attachments corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingItemAttachment
Retrieve a list of marketplace solution listing item attachments that match the criteria specified in the request body. Use this action for complex queries or when filter conditions exceed URL length 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 MP Solution Listing Item Attachments corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingItemAttachment
Retrieve a list of marketplace solution listing item attachments filtered by standard query parameters. Use this action to view or search attachments through the member portal 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 MP Solution Listing Item Attachment by id.
/prm/api/objects/v1/MPSolutionListingItemAttachment/{id}
Retrieve a single marketplace solution listing item attachment by its unique identifier. Use this action to inspect details of a specific attachment record via the member portal 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 MP Solution Listing Item Attachment.
/prm/api/objects/v1/MPSolutionListingItemAttachment/_export/types
Retrieve the list of supported file formats and export types for marketplace solution listing item attachments. Use this action prior to generating an export to verify accepted formats.
Parameters
|
Parameter Name |
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 MP Solution Listing Item Attachment based on the specified view model.
/prm/api/objects/v1/MPSolutionListingItemAttachment/{id}
Update specific fields of an existing marketplace solution listing item attachment by its unique identifier. Use this action to apply partial modifications to an attachment record in the member portal 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 MP Solution Listing Item Attachments based on the specified view models.
/prm/api/objects/v1/MPSolutionListingItemAttachment
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. |
MPSolutionListingItemRequest Admin API (11)
PUT Adds a single or many MP Solution Listing Item Requests based on the specified view model(s).
/api/objects/v1/MPSolutionListingItemRequest
Create one or more marketplace solution listing item requests using the administrative API. Use this action to register new listing item requests in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Solution Listing Item Request by id.
/api/objects/v1/MPSolutionListingItemRequest/{id}
Delete an individual marketplace solution listing item request by its unique identifier. Use this action to permanently remove a specific request record 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 MP Solution Listing Item Requests by id.
/api/objects/v1/MPSolutionListingItemRequest
Delete multiple marketplace solution listing item requests at once by their identifiers. Use this action to batch-remove request records via the administrative API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the MP Solution Listing Item Requests based on the given data fields.
/api/objects/v1/MPSolutionListingItemRequest/_export
Export marketplace solution listing item requests based on filter criteria defined in the request body. Use this action to extract request data when filters require complex configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Item Requests based on the same get parameters.
/api/objects/v1/MPSolutionListingItemRequest/_export
Export marketplace solution listing item requests matching the provided query parameters. Use this action to trigger an administrative export of request 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 MP Solution Listing Item Requests corresponding to the given data fields.
/api/objects/v1/MPSolutionListingItemRequest
Retrieve a list of marketplace solution listing item requests matching the criteria supplied in the request body. Use this action for administrative searches requiring advanced filtering logic.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Item Requests corresponding to the given parameters.
/api/objects/v1/MPSolutionListingItemRequest
Retrieve a list of marketplace solution listing item requests filtered by query parameters. Use this action for administrative browsing and searching of listing requests.
Parameters
|
Parameter Name |
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 MP Solution Listing Item Request by id.
/api/objects/v1/MPSolutionListingItemRequest/{id}
Retrieve the details of a single marketplace solution listing item request by its unique identifier. Use this action to inspect a specific request record with 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). |
GET Gets the Export types available for MP Solution Listing Item Request.
/api/objects/v1/MPSolutionListingItemRequest/_export/types
Retrieve the available export file types for marketplace solution listing item requests through 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 MP Solution Listing Item Request based on the specified view model.
/api/objects/v1/MPSolutionListingItemRequest/{id}
Update specific fields of an existing marketplace solution listing item request by its identifier through 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 MP Solution Listing Item Requests based on the specified view models.
/api/objects/v1/MPSolutionListingItemRequest
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. |
MPSolutionListingItemRequest Member API (11)
PUT Adds a single or many MP Solution Listing Item Requests based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingItemRequest
Create or update one or more marketplace solution listing item requests 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 MP Solution Listing Item Request by id.
/prm/api/objects/v1/MPSolutionListingItemRequest/{id}
Delete a single marketplace solution listing item request by its identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Solution Listing Item Requests by id.
/prm/api/objects/v1/MPSolutionListingItemRequest
Delete multiple marketplace solution listing item requests in a single operation 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 MP Solution Listing Item Requests based on the given data fields.
/prm/api/objects/v1/MPSolutionListingItemRequest/_export
Export marketplace solution listing item requests using specified payload filter 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 (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 MP Solution Listing Item Requests based on the same get parameters.
/prm/api/objects/v1/MPSolutionListingItemRequest/_export
Export marketplace solution listing item requests based on query string filter 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 MP Solution Listing Item Requests corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingItemRequest
Retrieve a list of marketplace solution listing item requests matching the criteria provided in the request body via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Solution Listing Item Requests corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingItemRequest
Retrieve a list of marketplace solution listing item requests matching 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 MP Solution Listing Item Request by id.
/prm/api/objects/v1/MPSolutionListingItemRequest/{id}
Retrieve the details of a single marketplace solution listing item request by its identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
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 MP Solution Listing Item Request.
/prm/api/objects/v1/MPSolutionListingItemRequest/_export/types
Retrieve the available export file formats for marketplace solution listing item requests using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Solution Listing Item Request based on the specified view model.
/prm/api/objects/v1/MPSolutionListingItemRequest/{id}
Update specific fields of an existing marketplace solution listing item request by its identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Solution Listing Item Requests based on the specified view models.
/prm/api/objects/v1/MPSolutionListingItemRequest
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. |
MPSolutionListingItemRequestAttachment Admin API (11)
PUT Adds a single or many MP Solution Listing Item Request Attachements based on the specified view model(s).
/api/objects/v1/MPSolutionListingItemRequestAttachment
Create or update one or more marketplace solution listing item request attachments through 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 MP Solution Listing Item Request Attachement by id.
/api/objects/v1/MPSolutionListingItemRequestAttachment/{id}
Delete an individual marketplace solution listing item request attachment by its identifier through 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 MP Solution Listing Item Request Attachements by id.
/api/objects/v1/MPSolutionListingItemRequestAttachment
Delete multiple marketplace solution listing item request attachments through 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 MP Solution Listing Item Request Attachements based on the given data fields.
/api/objects/v1/MPSolutionListingItemRequestAttachment/_export
Export marketplace solution listing item request attachments based on data fields specified in the request body through 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 MP Solution Listing Item Request Attachements based on the same get parameters.
/api/objects/v1/MPSolutionListingItemRequestAttachment/_export
Export marketplace solution listing item request attachments based on query parameters through 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 MP Solution Listing Item Request Attachements corresponding to the given data fields.
/api/objects/v1/MPSolutionListingItemRequestAttachment
Retrieve a list of marketplace solution listing item request attachments 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 (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 MP Solution Listing Item Request Attachements corresponding to the given parameters.
/api/objects/v1/MPSolutionListingItemRequestAttachment
Retrieve a list of marketplace solution listing item request attachments 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 MP Solution Listing Item Request Attachement by id.
/api/objects/v1/MPSolutionListingItemRequestAttachment/{id}
Retrieve a single marketplace solution listing item request 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 MP Solution Listing Item Request Attachement.
/api/objects/v1/MPSolutionListingItemRequestAttachment/_export/types
Retrieve the supported export file types for marketplace solution listing item request attachments 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 MP Solution Listing Item Request Attachement based on the specified view model.
/api/objects/v1/MPSolutionListingItemRequestAttachment/{id}
Update specific fields of an existing marketplace solution listing item request 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 MP Solution Listing Item Request Attachements based on the specified view models.
/api/objects/v1/MPSolutionListingItemRequestAttachment
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. |
MPSolutionListingItemRequestAttachment Member API (11)
PUT Adds a single or many MP Solution Listing Item Request Attachements based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment
Create or update one or more marketplace solution listing item request attachments 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 view model payload containing account details to add. |
DELETE Deletes a single MP Solution Listing Item Request Attachement by id.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment/{id}
Delete a single marketplace solution listing item request 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 MP Solution Listing Item Request Attachements by id.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment
Delete multiple marketplace solution listing item request attachments by their unique identifiers 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 MP Solution Listing Item Request Attachements based on the given data fields.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment/_export
Export marketplace solution listing item request attachments based on filter criteria provided in the request body 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 (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 MP Solution Listing Item Request Attachements based on the same get parameters.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment/_export
Export marketplace solution listing item request attachments based on query parameters 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. |
|
|
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 MP Solution Listing Item Request Attachements corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment
Retrieve a list of marketplace solution listing item request attachments matching filter criteria specified in the request body 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 (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 MP Solution Listing Item Request Attachements corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment
Retrieve a list of marketplace solution listing item request attachments matching query parameters 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. |
|
|
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 MP Solution Listing Item Request Attachement by id.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment/{id}
Retrieve a single marketplace solution listing item request 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 MP Solution Listing Item Request Attachement.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment/_export/types
Retrieve the supported export file types for marketplace solution listing item request 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 MP Solution Listing Item Request Attachement based on the specified view model.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment/{id}
Update specific fields of an existing marketplace solution listing item request 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 MP Solution Listing Item Request Attachements based on the specified view models.
/prm/api/objects/v1/MPSolutionListingItemRequestAttachment
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. |
MPSolutionListingNote Admin API (8)
PUT Adds a single or many MP Solution Listing Notes based on the specified view model(s).
/api/objects/v1/MPSolutionListingNote
Create or update one or more marketplace solution listing notes 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 MP Solution Listing Note by id.
/api/objects/v1/MPSolutionListingNote/{id}
Delete a single marketplace solution listing note 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 MP Solution Listing Notes by id.
/api/objects/v1/MPSolutionListingNote
Delete multiple marketplace solution listing notes by their unique 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 MP Solution Listing Notes corresponding to the given data fields.
/api/objects/v1/MPSolutionListingNote
Retrieve a list of marketplace solution listing notes matching specified data criteria submitted in the request body. Use this administrative action when complex filters or search conditions are needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Notes corresponding to the given parameters.
/api/objects/v1/MPSolutionListingNote
Retrieve a list of marketplace solution listing notes using query parameters. Use this administrative action to look up multiple listing notes that match standard filter options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 MP Solution Listing Note by id.
/api/objects/v1/MPSolutionListingNote/{id}
Retrieve details of a single marketplace solution listing note by its unique identifier. Use this administrative action to fetch full information for a specific 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 MP Solution Listing Note based on the specified view model.
/api/objects/v1/MPSolutionListingNote/{id}
Update specific fields of an existing marketplace solution listing note by its unique identifier. Use this administrative action to modify note details 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 MP Solution Listing Notes based on the specified view models.
/api/objects/v1/MPSolutionListingNote
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. |
MPSolutionListingNote Member API (8)
PUT Adds a single or many MP Solution Listing Notes based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingNote
Create or update one or more marketplace solution listing notes as a portal member. Use this action to submit note entries 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 MP Solution Listing Note by id.
/prm/api/objects/v1/MPSolutionListingNote/{id}
Permanently remove a single marketplace solution listing note by its unique identifier. Use this member action to delete an individual note 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 MP Solution Listing Notes by id.
/prm/api/objects/v1/MPSolutionListingNote
Permanently remove multiple marketplace solution listing notes in a single request. Use this member action to batch-delete notes 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 MP Solution Listing Notes corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingNote
Retrieve a list of marketplace solution listing notes corresponding to criteria provided in the request body. Use this member action when searching for notes with advanced filtering 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 (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 MP Solution Listing Notes corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingNote
Retrieve a list of marketplace solution listing notes matching specified query parameters. Use this member action to browse or filter accessible listing notes.
Parameters
|
Parameter Name |
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 MP Solution Listing Note by id.
/prm/api/objects/v1/MPSolutionListingNote/{id}
Retrieve details of a specific marketplace solution listing note by its unique identifier. Use this member action to review an individual note's content and metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Solution Listing Note based on the specified view model.
/prm/api/objects/v1/MPSolutionListingNote/{id}
Update fields of an existing marketplace solution listing note by its unique identifier. Use this member action to apply partial modifications to a 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 MP Solution Listing Notes based on the specified view models.
/prm/api/objects/v1/MPSolutionListingNote
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. |
MPSolutionListingRequest Admin API (11)
PUT Adds a single or many MP Solution Listing Requests based on the specified view model(s).
/api/objects/v1/MPSolutionListingRequest
Create or update one or more marketplace solution listing requests using the provided view models. Use this administrative action to insert or overwrite listing requests individually or in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Solution Listing Request by id.
/api/objects/v1/MPSolutionListingRequest/{id}
Permanently delete an individual marketplace solution listing request by its unique identifier. Use this administrative action to remove an obsolete or invalid listing request.
Parameters
|
Parameter Name |
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 MP Solution Listing Requests by id.
/api/objects/v1/MPSolutionListingRequest
Permanently delete multiple marketplace solution listing requests by their identifiers. Use this administrative action to clean up multiple listing requests 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 Exports the MP Solution Listing Requests based on the given data fields.
/api/objects/v1/MPSolutionListingRequest/_export
Export marketplace solution listing request records matching the filter criteria provided in the request body. Use this administrative action to extract data sets for reporting or external processing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Requests based on the same get parameters.
/api/objects/v1/MPSolutionListingRequest/_export
Export marketplace solution listing request records based on standard query parameters. Use this administrative action to download request data using standard URL query filters.
Parameters
|
Parameter Name |
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 MP Solution Listing Requests corresponding to the given data fields.
/api/objects/v1/MPSolutionListingRequest
Retrieve a list of marketplace solution listing requests matching criteria specified in the request body. Use this administrative action for flexible querying and filtering of listing requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Requests corresponding to the given parameters.
/api/objects/v1/MPSolutionListingRequest
Retrieve a list of marketplace solution listing requests through the admin interface using query parameters. Use this action to search or filter listing requests.
Parameters
|
Parameter Name |
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 MP Solution Listing Request by id.
/api/objects/v1/MPSolutionListingRequest/{id}
Retrieve details for a specific marketplace solution listing request by its ID using admin 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 MP Solution Listing Request.
/api/objects/v1/MPSolutionListingRequest/_export/types
Retrieve the available export file types for marketplace solution listing requests through the admin 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). |
PATCH Updates a single MP Solution Listing Request based on the specified view model.
/api/objects/v1/MPSolutionListingRequest/{id}
Update specific fields of an existing marketplace solution listing request by ID using admin 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 MP Solution Listing Requests based on the specified view models.
/api/objects/v1/MPSolutionListingRequest
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. |
MPSolutionListingRequest Member API (11)
PUT Adds a single or many MP Solution Listing Requests based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingRequest
Create or update one or more marketplace solution listing requests through the member 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 MP Solution Listing Request by id.
/prm/api/objects/v1/MPSolutionListingRequest/{id}
Delete a single marketplace solution listing request by its ID through the member 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Solution Listing Requests by id.
/prm/api/objects/v1/MPSolutionListingRequest
Delete multiple marketplace solution listing requests simultaneously through the member 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 list of account IDs to delete. |
POST Exports the MP Solution Listing Requests based on the given data fields.
/prm/api/objects/v1/MPSolutionListingRequest/_export
Export marketplace solution listing requests through the member interface based on specified request body criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (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 MP Solution Listing Requests based on the same get parameters.
/prm/api/objects/v1/MPSolutionListingRequest/_export
Export marketplace solution listing requests through the member interface 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 MP Solution Listing Requests corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingRequest
Retrieve a list of marketplace solution listing requests through the member interface 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 MP Solution Listing Requests corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingRequest
Retrieve a list of marketplace solution listing requests through the member interface 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 MP Solution Listing Request by id.
/prm/api/objects/v1/MPSolutionListingRequest/{id}
Retrieve details for a single marketplace solution listing request by its ID through the member 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. |
|
|
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 MP Solution Listing Request.
/prm/api/objects/v1/MPSolutionListingRequest/_export/types
Retrieve the supported export file types for marketplace solution listing requests through the member 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). |
PATCH Updates a single MP Solution Listing Request based on the specified view model.
/prm/api/objects/v1/MPSolutionListingRequest/{id}
Update specific fields of an existing marketplace solution listing request by ID through the member 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. |
|
|
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 MP Solution Listing Requests based on the specified view models.
/prm/api/objects/v1/MPSolutionListingRequest
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. |
MPSolutionListingRequestNote Admin API (8)
PUT Adds a single or many MP Solution Listing Request Notes based on the specified view model(s).
/api/objects/v1/MPSolutionListingRequestNote
Create or update one or more marketplace solution listing request notes using admin 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 MP Solution Listing Request Note by id.
/api/objects/v1/MPSolutionListingRequestNote/{id}
Delete a single marketplace solution listing request note by its ID using admin 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 MP Solution Listing Request Notes by id.
/api/objects/v1/MPSolutionListingRequestNote
Delete multiple marketplace solution listing request notes simultaneously using admin 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 MP Solution Listing Request Notes corresponding to the given data fields.
/api/objects/v1/MPSolutionListingRequestNote
Retrieve a list of marketplace solution listing request notes based on criteria provided in the request body using admin 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 MP Solution Listing Request Notes corresponding to the given parameters.
/api/objects/v1/MPSolutionListingRequestNote
Retrieve a list of marketplace solution listing request notes matching specified query parameters using admin 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 MP Solution Listing Request Note by id.
/api/objects/v1/MPSolutionListingRequestNote/{id}
Retrieve a specific marketplace solution listing request note by its ID using admin 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 MP Solution Listing Request Note based on the specified view model.
/api/objects/v1/MPSolutionListingRequestNote/{id}
Update specific fields of an existing marketplace solution listing request note by its ID using admin 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 MP Solution Listing Request Notes based on the specified view models.
/api/objects/v1/MPSolutionListingRequestNote
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. |
MPSolutionListingRequestNote Member API (8)
PUT Adds a single or many MP Solution Listing Request Notes based on the specified view model(s).
/prm/api/objects/v1/MPSolutionListingRequestNote
Create one or multiple marketplace solution listing request notes. Use this action to record new notes associated with marketplace solution listing requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 MP Solution Listing Request Note by id.
/prm/api/objects/v1/MPSolutionListingRequestNote/{id}
Permanently delete an individual marketplace solution listing request note 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Solution Listing Request Notes by id.
/prm/api/objects/v1/MPSolutionListingRequestNote
Permanently delete multiple marketplace solution listing request notes 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 MP Solution Listing Request Notes corresponding to the given data fields.
/prm/api/objects/v1/MPSolutionListingRequestNote
Search and retrieve a list of marketplace solution listing request notes matching specified filter 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 (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 MP Solution Listing Request Notes corresponding to the given parameters.
/prm/api/objects/v1/MPSolutionListingRequestNote
Retrieve a list of marketplace solution listing request notes 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 MP Solution Listing Request Note by id.
/prm/api/objects/v1/MPSolutionListingRequestNote/{id}
Retrieve details of a single marketplace solution listing request 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 MP Solution Listing Request Note based on the specified view model.
/prm/api/objects/v1/MPSolutionListingRequestNote/{id}
Update specific fields of an existing marketplace solution listing request note 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 MP Solution Listing Request Notes based on the specified view models.
/prm/api/objects/v1/MPSolutionListingRequestNote
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. |
MarketplaceListing Admin API (2)
GET /api/objects/v1/marketplaceListing/config
/api/objects/v1/marketplaceListing/config
Retrieve marketplace listing configuration settings for administrative 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 response format expected from the API (e.g. application/json). |
POST /api/objects/v1/marketplaceSolutionListing/requestStatus/{updatedStatus}/{mpSolutionListingRequestId}
/api/objects/v1/marketplaceSolutionListing/requestStatus/{updatedStatus}/{mpSolutionListingRequestId}
Update the request status of a marketplace solution listing 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. |
|
|
Specifies the new status value to apply to the marketplace solution listing request. |
|
|
The unique identifier of the marketplace solution listing request to update. |
|
|
The response format expected from the API (e.g. application/json). |
MarketplaceListing Member API (2)
GET /prm/api/objects/v1/marketplaceListing/config
/prm/api/objects/v1/marketplaceListing/config
Retrieve marketplace listing configuration settings 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. |
|
|
The response format expected from the API (e.g. application/json). |
POST /prm/api/objects/v1/marketplaceSolutionListing/requestStatus/{updatedStatus}/{mpSolutionListingRequestId}
/prm/api/objects/v1/marketplaceSolutionListing/requestStatus/{updatedStatus}/{mpSolutionListingRequestId}
Update the request status of a marketplace solution listing on behalf of a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specifies the new status value to apply to the marketplace solution listing request. |
|
|
The unique identifier of the marketplace solution listing request to update. |
|
|
The response format expected from the API (e.g. application/json). |
MassUpdateTask Admin API (8)
PUT Adds a single or many Mass Update Tasks based on the specified view model(s).
/api/objects/v1/MassUpdateTask
Create one or more mass update tasks within 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 Mass Update Task by id.
/api/objects/v1/MassUpdateTask/{id}
Permanently delete a specific mass update task 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 Mass Update Tasks by id.
/api/objects/v1/MassUpdateTask
Permanently delete multiple mass update tasks simultaneously.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Mass Update Tasks corresponding to the given data fields.
/api/objects/v1/MassUpdateTask
Search and retrieve a list of mass update tasks based on 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 Mass Update Tasks corresponding to the given parameters.
/api/objects/v1/MassUpdateTask
Retrieve a list of mass update tasks 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 Mass Update Task by id.
/api/objects/v1/MassUpdateTask/{id}
Retrieve the details of a single mass update task 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 Mass Update Task based on the specified view model.
/api/objects/v1/MassUpdateTask/{id}
Modify specific fields of an existing mass update task by its 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 Mass Update Tasks based on the specified view models.
/api/objects/v1/MassUpdateTask
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. |
MassUpdateTask Member API (8)
PUT Adds a single or many Mass Update Tasks based on the specified view model(s).
/prm/api/objects/v1/MassUpdateTask
Create one or more mass update tasks as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 Mass Update Task by id.
/prm/api/objects/v1/MassUpdateTask/{id}
Permanently delete an individual mass update task by its identifier as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Mass Update Tasks by id.
/prm/api/objects/v1/MassUpdateTask
Permanently delete multiple mass update tasks 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 Mass Update Tasks corresponding to the given data fields.
/prm/api/objects/v1/MassUpdateTask
Retrieve a list of mass update tasks that match 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 Mass Update Tasks corresponding to the given parameters.
/prm/api/objects/v1/MassUpdateTask
Retrieve a list of mass update tasks based on query parameter filters.
Parameters
|
Parameter Name |
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 Mass Update Task by id.
/prm/api/objects/v1/MassUpdateTask/{id}
Retrieve the details of a single mass update task 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 Mass Update Task based on the specified view model.
/prm/api/objects/v1/MassUpdateTask/{id}
Update fields on an existing mass update task 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 Mass Update Tasks based on the specified view models.
/prm/api/objects/v1/MassUpdateTask
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. |
Mdf Admin API (2)
GET Gets the kpi's.
/api/objects/v1/mdf/getKpi
Retrieve Market Development Fund (MDF) key performance indicators for administrative reporting.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter KPIs to include data starting from this date. |
|
|
Filter KPIs to include data up to this date. |
|
|
Unique identifier of the member to filter KPI results for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the kpi's.
/api/objects/v1/mdf/getMemberKpi
Retrieve Market Development Fund (MDF) member-specific key performance indicators 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. |
|
|
Filter member KPIs starting from this date. |
|
|
Filter member KPIs up to this date. |
|
|
Unique identifier of the member whose KPIs are being queried. |
|
|
The response format expected from the API (e.g. application/json). |
Mdf Member API (2)
GET Gets the kpi's.
/prm/api/objects/v1/mdf/getKpi
Retrieve Market Development Fund (MDF) key performance indicators 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. |
|
|
Filter KPIs to include data starting from this date. |
|
|
Filter KPIs to include data up to this date. |
|
|
Unique identifier of the member to scope KPI data. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the kpi's.
/prm/api/objects/v1/mdf/getMemberKpi
Retrieve member-level Market Development Fund (MDF) key performance indicators for the active member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter member KPIs starting from this date. |
|
|
Filter member KPIs up to this date. |
|
|
Unique identifier of the member to filter metrics. |
|
|
The response format expected from the API (e.g. application/json). |
MdfPayments Admin API (4)
POST Insert a reward history record relating to an update - which also may require updating a claim
/api/objects/v1/mdfpayments/insertRewardUpdatedHistory
Insert a history log entry for an updated MDF reward payment, with optional adjustments to the associated claim.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim linked to the updated reward. |
|
|
Updated payment amount granted for the reward. |
|
|
Initial amount requested on the claim prior to modifications. |
|
|
Three-letter currency code representing the reward and claim amounts. |
|
|
Identifier of the payment batch associated with this reward update. |
|
|
Unique identifier of the reward record being updated. |
|
|
Current processing status of the updated reward payment. |
|
|
External reference identifier corresponding to the payment transaction. |
|
|
Date and time when the update history record was generated. |
|
|
Error description or message if the reward update encountered an issue. |
POST Insert a reward history record when a reward is cancelled
/api/objects/v1/mdfpayments/insertRewardCancelledHistory
Insert a history log entry when an MDF reward payment has been cancelled.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim tied to the cancelled reward. |
|
|
Payout amount of the reward that was cancelled. |
|
|
Original monetary amount requested on the associated claim. |
|
|
Three-letter currency code used for the cancelled payment. |
|
|
Identifier for the batch that contained the cancelled reward. |
|
|
Unique identifier of the cancelled reward. |
|
|
Status value indicating the cancellation state of the reward. |
|
|
External reference or transaction ID associated with the cancellation. |
|
|
Date and time when the cancellation history record was recorded. |
|
|
Details explaining any error or reason tied to the cancellation. |
POST Insert a reward history record when a reward is cancelled
/api/objects/v1/mdfpayments/insertRewardErrorHistory
Record an error or cancellation history entry for a reward from an administrative perspective. Use this to log payment failures or cancellations in the MDF payment system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim tied to the cancelled reward. |
|
|
Payout amount of the reward that was cancelled. |
|
|
Original monetary amount requested on the associated claim. |
|
|
Three-letter currency code used for the cancelled payment. |
|
|
Identifier for the batch that contained the cancelled reward. |
|
|
Unique identifier of the cancelled reward. |
|
|
Status value indicating the cancellation state of the reward. |
|
|
External reference or transaction ID associated with the cancellation. |
|
|
Date and time when the cancellation history record was recorded. |
|
|
Details explaining any error or reason tied to the cancellation. |
POST Insert the initial reward history record
/api/objects/v1/mdfpayments/insertRewardCreatedHistory
Create and insert the initial history entry when a reward is created. Use this via the admin interface to log the inception of an MDF payment reward.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim tied to the cancelled reward. |
|
|
Payout amount of the reward that was cancelled. |
|
|
Original monetary amount requested on the associated claim. |
|
|
Three-letter currency code used for the cancelled payment. |
|
|
Identifier for the batch that contained the cancelled reward. |
|
|
Unique identifier of the cancelled reward. |
|
|
Status value indicating the cancellation state of the reward. |
|
|
External reference or transaction ID associated with the cancellation. |
|
|
Date and time when the cancellation history record was recorded. |
|
|
Details explaining any error or reason tied to the cancellation. |
MdfPayments Member API (4)
POST Insert a reward history record relating to an update - which also may require updating a claim
/prm/api/objects/v1/mdfpayments/insertRewardUpdatedHistory
Record a history entry for updates made to a reward from the member portal. This action can also trigger corresponding updates to the associated claim.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim tied to the cancelled reward. |
|
|
Payout amount of the reward that was cancelled. |
|
|
Original monetary amount requested on the associated claim. |
|
|
Three-letter currency code used for the cancelled payment. |
|
|
Identifier for the batch that contained the cancelled reward. |
|
|
Unique identifier of the cancelled reward. |
|
|
Status value indicating the cancellation state of the reward. |
|
|
External reference or transaction ID associated with the cancellation. |
|
|
Date and time when the cancellation history record was recorded. |
|
|
Details explaining any error or reason tied to the cancellation. |
POST Insert a reward history record when a reward is cancelled
/prm/api/objects/v1/mdfpayments/insertRewardCancelledHistory
Insert a reward history entry logging that a reward has been cancelled. Use this to keep an audit trail of reward cancellations initiated by or for a member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim tied to the cancelled reward. |
|
|
Payout amount of the reward that was cancelled. |
|
|
Original monetary amount requested on the associated claim. |
|
|
Three-letter currency code used for the cancelled payment. |
|
|
Identifier for the batch that contained the cancelled reward. |
|
|
Unique identifier of the cancelled reward. |
|
|
Status value indicating the cancellation state of the reward. |
|
|
External reference or transaction ID associated with the cancellation. |
|
|
Date and time when the cancellation history record was recorded. |
|
|
Details explaining any error or reason tied to the cancellation. |
POST Insert a reward history record when a reward is cancelled
/prm/api/objects/v1/mdfpayments/insertRewardErrorHistory
Log an error history entry for a reward cancellation in the member portal. Use this to capture payment failure or cancellation event details for member-facing reward 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 (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim tied to the cancelled reward. |
|
|
Payout amount of the reward that was cancelled. |
|
|
Original monetary amount requested on the associated claim. |
|
|
Three-letter currency code used for the cancelled payment. |
|
|
Identifier for the batch that contained the cancelled reward. |
|
|
Unique identifier of the cancelled reward. |
|
|
Status value indicating the cancellation state of the reward. |
|
|
External reference or transaction ID associated with the cancellation. |
|
|
Date and time when the cancellation history record was recorded. |
|
|
Details explaining any error or reason tied to the cancellation. |
POST Insert the initial reward history record
/prm/api/objects/v1/mdfpayments/insertRewardCreatedHistory
Record the initial reward creation history entry for market development fund payments. Use this action to establish the baseline audit record when a new reward is created.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Unique identifier of the claim tied to the cancelled reward. |
|
|
Payout amount of the reward that was cancelled. |
|
|
Original monetary amount requested on the associated claim. |
|
|
Three-letter currency code used for the cancelled payment. |
|
|
Identifier for the batch that contained the cancelled reward. |
|
|
Unique identifier of the cancelled reward. |
|
|
Status value indicating the cancellation state of the reward. |
|
|
External reference or transaction ID associated with the cancellation. |
|
|
Date and time when the cancellation history record was recorded. |
|
|
Details explaining any error or reason tied to the cancellation. |
MemberAttachment Admin API (11)
PUT Adds a single or many User Attachments based on the specified view model(s).
/api/objects/v1/MemberAttachment
Create or replace one or more member attachment records with administrative privileges. Use this action to upload or link user attachments in bulk or individually based on 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. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single User Attachment by id.
/api/objects/v1/MemberAttachment/{id}
Permanently remove a specific member attachment by its identifier using administrative permissions. Use this action when a single user attachment needs to be deleted 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 User Attachments by id.
/api/objects/v1/MemberAttachment
Permanently remove multiple member attachments simultaneously with administrative privileges. Use this action to batch-delete user attachments 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 User Attachments based on the given data fields.
/api/objects/v1/MemberAttachment/_export
Export member attachment data according to specified data field criteria using an administrative request. Use this action when you need to extract user attachments matching complex filter payloads.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the User Attachments based on the same get parameters.
/api/objects/v1/MemberAttachment/_export
Export member attachment records using standard query parameters with administrative access. Use this action to generate an export file of user attachments matching specified filter criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of User Attachments corresponding to the given data fields.
/api/objects/v1/MemberAttachment
Retrieve a list of member attachments matching specified criteria provided in the request body with administrative privileges. Use this action when querying user attachments with complex filter 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 (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of User Attachments corresponding to the given parameters.
/api/objects/v1/MemberAttachment
Retrieve a list of member attachments matching the supplied query parameters using administrative access. Use this action to browse or search existing user attachments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single User Attachment by id.
/api/objects/v1/MemberAttachment/{id}
Retrieve details of a single member attachment by its identifier using administrative permissions. Use this action to view metadata and properties for a specific user attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for User Attachment.
/api/objects/v1/MemberAttachment/_export/types
Retrieve the supported file and export formats available for member attachments. Use this action to discover the export options supported by administrative attachment exports.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User Attachment based on the specified view model.
/api/objects/v1/MemberAttachment/{id}
Update specific fields of an existing member attachment using administrative privileges. Use this action to apply partial changes to a user 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 User Attachments based on the specified view models.
/api/objects/v1/MemberAttachment
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. |
MemberAttachment Member API (11)
PUT Adds a single or many User Attachments based on the specified view model(s).
/prm/api/objects/v1/MemberAttachment
Create or update one or more member attachments on behalf of a portal member. Use this action to submit user attachments 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 User Attachment by id.
/prm/api/objects/v1/MemberAttachment/{id}
Permanently delete a specific member attachment by its identifier within the member portal context. Use this action when a portal member needs to remove an individual attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many User Attachments by id.
/prm/api/objects/v1/MemberAttachment
Permanently delete multiple member attachments at once within the member portal context. Use this action to batch-remove user attachments owned by or accessible to the member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the User Attachments based on the given data fields.
/prm/api/objects/v1/MemberAttachment/_export
Export member attachment records based on data field specifications using member-level access. Use this action to generate an export of user attachments accessible to the authenticated member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the User Attachments based on the same get parameters.
/prm/api/objects/v1/MemberAttachment/_export
Export user attachments matching standard retrieval parameters into a downloadable 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 User Attachments corresponding to the given data fields.
/prm/api/objects/v1/MemberAttachment
Retrieve a list of user attachments matching specific data fields sent 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 User Attachments corresponding to the given parameters.
/prm/api/objects/v1/MemberAttachment
Retrieve a list of user attachments 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 User Attachment by id.
/prm/api/objects/v1/MemberAttachment/{id}
Retrieve details of a single user attachment 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). |
GET Gets the Export types available for User Attachment.
/prm/api/objects/v1/MemberAttachment/_export/types
Retrieve the available export file types supported for user attachments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single User Attachment based on the specified view model.
/prm/api/objects/v1/MemberAttachment/{id}
Update specific fields of an existing user attachment by its 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 User Attachments based on the specified view models.
/prm/api/objects/v1/MemberAttachment
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. |
Momentum Member API
GET /prm/api/objects/v1/momentum/_evaluate
/prm/api/objects/v1/momentum/_evaluate
Evaluate momentum based on provided text criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The text string to be evaluated by the momentum engine. |
|
|
The response format expected from the API (e.g. application/json). |
Notes Admin API (20)
PUT Create a MP Partner Listing Note.
/api/objects/v1/vpn/CreateMPPartnerListingNote
Create a note associated with a Marketplace Partner Listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the partner listing to which the note belongs. |
PUT Create a MP Solution Listing Note.
/api/objects/v1/vpn/CreateMPSolutionListingNote
Create a note associated with a Marketplace Solution Listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution listing to which the note belongs. |
PUT Create the Competency Claim Note.
/api/objects/v1/vpn/CreateCompetencyClaimNote
Create a note associated with a competency claim.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the competency claim to which the note belongs. |
PUT Create the MP Contact Note.
/api/objects/v1/vpn/CreateMPContactNote
Create a note associated with a Marketplace Contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the marketplace contact to which the note belongs. |
PUT Create the MP Listing Request Note.
/api/objects/v1/vpn/CreateMPPartnerListingRequestNote
Create a note associated with a Marketplace Partner Listing 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 (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the partner listing request to which the note belongs. |
PUT Create the MP Solution Contact Note.
/api/objects/v1/vpn/CreateMPSolutionContactNote
Create a note associated with a Marketplace Solution Contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the MP Solution Listing Request Note.
/api/objects/v1/vpn/CreateMPSolutionListingRequestNote
Create a new note associated with a marketplace solution listing 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 (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the bp partner plan note.
/api/objects/v1/vpn/CreateBpPartnerPlanNote
Create a new note for a business partner 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. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the mdf claim note.
/api/objects/v1/vpn/CreateMdfClaimNote
Create a new note associated with a market development fund (MDF) claim.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the mdf request note.
/api/objects/v1/vpn/CreateMdfRequestNote
Create a new note associated with a market development fund (MDF) 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 (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
GET Gets the notes for Competency Claim.
/api/objects/v1/vpn/CompetencyClaimNotes
Retrieve notes associated with a competency claim.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the competency claim record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Contact.
/api/objects/v1/vpn/MPContactNotes
Retrieve notes associated with a marketplace contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the marketplace contact record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Partner Listing Request.
/api/objects/v1/vpn/MPPartnerListingRequestNotes
Retrieve notes associated with a marketplace partner listing request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the marketplace partner listing request to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Partner Listings.
/api/objects/v1/vpn/MPPartnerListingNotes
Retrieve notes associated with marketplace partner 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. |
|
|
Unique identifier of the marketplace partner listing to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Solution Contact.
/api/objects/v1/vpn/MPSolutionContactNotes
Retrieve notes associated with a marketplace solution contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the marketplace solution contact to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Solution Listing Request.
/api/objects/v1/vpn/MPSolutionListingRequestNotes
Retrieve notes associated with a marketplace solution listing request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the marketplace solution listing request to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Solution Listings.
/api/objects/v1/vpn/MPSolutionListingNotes
Retrieve notes associated with marketplace solution 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. |
|
|
Unique identifier of the marketplace solution listing to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for bp partner plan notes.
/api/objects/v1/vpn/bpPartnerPlanNotes
Retrieve notes associated with a business partner 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. |
|
|
Unique identifier of the partner plan record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for mdf claim notes.
/api/objects/v1/vpn/mdfClaimNotes
Retrieve notes associated with a market development fund (MDF) claim.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF claim record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for mdf requests notes.
/api/objects/v1/vpn/mdfRequestNotes
Retrieve notes associated with a market development fund (MDF) request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
Notes Member API (20)
PUT Create a MP Partner Listing Note.
/prm/api/objects/v1/vpn/CreateMPPartnerListingNote
Create a note for a marketplace partner listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create a MP Solution Listing Note.
/prm/api/objects/v1/vpn/CreateMPSolutionListingNote
Create a new Marketplace Solution Listing note. Use this action to record comments or updates against a specific marketplace solution listing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the Competency Claim Note.
/prm/api/objects/v1/vpn/CreateCompetencyClaimNote
Create a new note on a competency claim. Use this action to attach notes, remarks, or review details to competency claims.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the MP Contact Note.
/prm/api/objects/v1/vpn/CreateMPContactNote
Create a new Marketplace Contact note. Use this action to log communication history or internal notes associated with a marketplace contact.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the MP Listing Request Note.
/prm/api/objects/v1/vpn/CreateMPPartnerListingRequestNote
Create a new note on a marketplace partner listing request. Use this action to document updates, feedback, or processing notes for a listing 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 (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the MP Solution Contact Note.
/prm/api/objects/v1/vpn/CreateMPSolutionContactNote
Create a new note for a marketplace solution contact. Use this action to record communication notes or updates for contacts associated with a marketplace solution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the MP Solution Listing Request Note.
/prm/api/objects/v1/vpn/CreateMPSolutionListingRequestNote
Create a new note for a marketplace solution listing request. Use this action to track discussions or internal notes regarding a solution listing 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 (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the bp partner plan note.
/prm/api/objects/v1/vpn/CreateBpPartnerPlanNote
Create a new note on a business partner plan. Use this action to log progress updates, comments, or details related to a partner 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. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the mdf claim note.
/prm/api/objects/v1/vpn/CreateMdfClaimNote
Create a new note for a Market Development Funds (MDF) claim. Use this action to add audit notes, comments, or review details to an MDF claim.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
PUT Create the mdf request note.
/prm/api/objects/v1/vpn/CreateMdfRequestNote
Create a new note on a Market Development Funds (MDF) request. Use this action to record feedback, status updates, or approval notes for an MDF 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 (5)
|
Option Name |
Description |
|---|---|
|
|
The topic or headline associated with the asset. |
|
|
An optional explanation or reason for applying the tier override. |
|
|
The timestamp or date indicating when the note was added. |
|
|
The user identifier or name of the person creating the note. |
|
|
The identifier of the solution contact to which the note belongs. |
GET Gets the notes for Competency Claim.
/prm/api/objects/v1/vpn/CompetencyClaimNotes
Retrieve existing notes associated with competency claims. Use this action to view history, comments, or details logged against competency claims.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Contact.
/prm/api/objects/v1/vpn/MPContactNotes
Retrieve notes associated with marketplace contacts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Partner Listing Request.
/prm/api/objects/v1/vpn/MPPartnerListingRequestNotes
Retrieve notes associated with marketplace partner listing requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Partner Listings.
/prm/api/objects/v1/vpn/MPPartnerListingNotes
Retrieve notes associated with marketplace partner 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. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Solution Contact.
/prm/api/objects/v1/vpn/MPSolutionContactNotes
Retrieve notes associated with marketplace solution contacts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Solution Listing Request.
/prm/api/objects/v1/vpn/MPSolutionListingRequestNotes
Retrieve notes associated with marketplace solution listing requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for MP Solution Listings.
/prm/api/objects/v1/vpn/MPSolutionListingNotes
Retrieve notes associated with marketplace solution 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. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for bp partner plan notes.
/prm/api/objects/v1/vpn/bpPartnerPlanNotes
Retrieve notes associated with 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. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for mdf claim notes.
/prm/api/objects/v1/vpn/mdfClaimNotes
Retrieve notes associated with market development fund (MDF) claims.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the notes for mdf requests notes.
/prm/api/objects/v1/vpn/mdfRequestNotes
Retrieve notes associated with market development fund (MDF) requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Unique identifier of the MDF request record to retrieve notes for. |
|
|
The response format expected from the API (e.g. application/json). |
ObjectAttachment Admin API (4)
DELETE Deletes a single Object Attachment by id.
/api/objects/v1/ObjectAttachment/{id}
Permanently delete a specific object attachment by its unique identifier using administrator 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 Object Attachments by id.
/api/objects/v1/ObjectAttachment
Permanently delete multiple object attachments in bulk using administrator 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 Object Attachment based on the specified view model.
/api/objects/v1/ObjectAttachment/{id}
Update properties of a single object attachment by its unique identifier using administrator 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 Object Attachments based on the specified view models.
/api/objects/v1/ObjectAttachment
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. |
ObjectAttachment Member API (4)
DELETE Deletes a single Object Attachment by id.
/prm/api/objects/v1/ObjectAttachment/{id}
Permanently delete a specific object attachment by its unique identifier using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Object Attachments by id.
/prm/api/objects/v1/ObjectAttachment
Permanently delete multiple object attachments in bulk using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Object Attachment based on the specified view model.
/prm/api/objects/v1/ObjectAttachment/{id}
Update properties of a single object attachment by its unique identifier using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 Object Attachments based on the specified view models.
/prm/api/objects/v1/ObjectAttachment
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. |
ObjectEngagement Admin API (4)
DELETE Deletes a single Object Engagement by id.
/api/objects/v1/ObjectEngagement/{id}
Permanently delete a single object engagement by its unique identifier using administrator 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 Object Engagements by id.
/api/objects/v1/ObjectEngagement
Permanently delete multiple object engagements in bulk using administrator 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 Object Engagement based on the specified view model.
/api/objects/v1/ObjectEngagement/{id}
Update properties of a single object engagement by its unique identifier using administrator 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 Object Engagements based on the specified view models.
/api/objects/v1/ObjectEngagement
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. |
ObjectEngagement Member API (4)
DELETE Deletes a single Object Engagement by id.
/prm/api/objects/v1/ObjectEngagement/{id}
Permanently delete a single object engagement by its unique identifier using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Object Engagements by id.
/prm/api/objects/v1/ObjectEngagement
Permanently delete multiple object engagements in bulk using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Object Engagement based on the specified view model.
/prm/api/objects/v1/ObjectEngagement/{id}
Update properties of a single object engagement by its unique identifier using member portal permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 Object Engagements based on the specified view models.
/prm/api/objects/v1/ObjectEngagement
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. |
ObjectShare Admin API (4)
DELETE Deletes a single Object Share by id.
/api/objects/v1/ObjectShare/{id}
Permanently delete an individual object share 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 Object Shares by id.
/api/objects/v1/ObjectShare
Permanently delete multiple object shares simultaneously by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Object Share based on the specified view model.
/api/objects/v1/ObjectShare/{id}
Update specific fields of an existing object share 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 Object Shares based on the specified view models.
/api/objects/v1/ObjectShare
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. |
ObjectShare Member API (4)
DELETE Deletes a single Object Share by id.
/prm/api/objects/v1/ObjectShare/{id}
Permanently delete an individual object share 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 Object Shares by id.
/prm/api/objects/v1/ObjectShare
Permanently delete multiple object shares simultaneously by their identifiers 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 Object Share based on the specified view model.
/prm/api/objects/v1/ObjectShare/{id}
Update specific fields of an existing object share by its identifier 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 Object Shares based on the specified view models.
/prm/api/objects/v1/ObjectShare
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. |
PartnerLevel Admin API (3)
POST Gets a list of Partner Levels corresponding to the given data fields.
/api/objects/v1/PartnerLevel
Retrieve a list of partner levels matching the 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 Partner Levels corresponding to the given parameters.
/api/objects/v1/PartnerLevel
Retrieve a list of partner levels 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 Partner Level by id.
/api/objects/v1/PartnerLevel/{id}
Retrieve the details of a single partner level 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). |
PartnerLevel Member API (3)
POST Gets a list of Partner Levels corresponding to the given data fields.
/prm/api/objects/v1/PartnerLevel
Retrieve a list of partner levels matching the criteria specified 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 Partner Levels corresponding to the given parameters.
/prm/api/objects/v1/PartnerLevel
Retrieve a list of partner levels matching specified query parameters 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 Partner Level by id.
/prm/api/objects/v1/PartnerLevel/{id}
Retrieve the details of a single partner level 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). |
PartnerRole Admin API (8)
PUT Adds a single or many Partner Roles based on the specified view model(s).
/api/objects/v1/PartnerRole
Create or replace one or more partner roles 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 Partner Role by id.
/api/objects/v1/PartnerRole/{id}
Permanently delete an individual partner role 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 Partner Roles by id.
/api/objects/v1/PartnerRole
Permanently delete multiple partner roles simultaneously by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Partner Roles corresponding to the given data fields.
/api/objects/v1/PartnerRole
Retrieve a list of partner roles matching the 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 Partner Roles corresponding to the given parameters.
/api/objects/v1/PartnerRole
Retrieve a list of partner roles 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 Partner Role by id.
/api/objects/v1/PartnerRole/{id}
Retrieve the details of a single partner role 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 Partner Role based on the specified view model.
/api/objects/v1/PartnerRole/{id}
Update specific fields of an existing partner role 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 Partner Roles based on the specified view models.
/api/objects/v1/PartnerRole
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. |
PartnerRole Member API (8)
PUT Adds a single or many Partner Roles based on the specified view model(s).
/prm/api/objects/v1/PartnerRole
Create one or more partner roles using 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 Partner Role by id.
/prm/api/objects/v1/PartnerRole/{id}
Permanently delete a specific partner role identified 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Partner Roles by id.
/prm/api/objects/v1/PartnerRole
Permanently delete multiple partner roles by their IDs via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Partner Roles corresponding to the given data fields.
/prm/api/objects/v1/PartnerRole
Retrieve a list of partner roles matching the specified data fields 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 Partner Roles corresponding to the given parameters.
/prm/api/objects/v1/PartnerRole
Retrieve a list of partner roles 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 Partner Role by id.
/prm/api/objects/v1/PartnerRole/{id}
Retrieve details for a single partner role 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Partner Role based on the specified view model.
/prm/api/objects/v1/PartnerRole/{id}
Update fields of an existing partner role identified by its ID 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 Partner Roles based on the specified view models.
/prm/api/objects/v1/PartnerRole
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. |
PartnerRolePermission Admin API (8)
PUT Adds a single or many Partner Role Permissions based on the specified view model(s).
/api/objects/v1/PartnerRolePermission
Create one or more partner role permissions using 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 Partner Role Permission by id.
/api/objects/v1/PartnerRolePermission/{id}
Permanently delete a single partner role permission by its ID 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 Partner Role Permissions by id.
/api/objects/v1/PartnerRolePermission
Permanently delete multiple partner role permissions by their IDs via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Partner Role Permissions corresponding to the given data fields.
/api/objects/v1/PartnerRolePermission
Retrieve a list of partner role permissions matching the specified data fields 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 Partner Role Permissions corresponding to the given parameters.
/api/objects/v1/PartnerRolePermission
Retrieve a list of partner role permissions matching the specified query parameters via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Partner Role Permission by id.
/api/objects/v1/PartnerRolePermission/{id}
Retrieve details for a single partner role permission by its ID via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Partner Role Permission based on the specified view model.
/api/objects/v1/PartnerRolePermission/{id}
Update an existing partner role permission identified 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 Partner Role Permissions based on the specified view models.
/api/objects/v1/PartnerRolePermission
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. |
PartnerRolePermission Member API (8)
PUT Adds a single or many Partner Role Permissions based on the specified view model(s).
/prm/api/objects/v1/PartnerRolePermission
Create one or more partner role permissions using 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 Partner Role Permission by id.
/prm/api/objects/v1/PartnerRolePermission/{id}
Permanently delete a single partner role permission 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Partner Role Permissions by id.
/prm/api/objects/v1/PartnerRolePermission
Permanently delete multiple partner role permissions by their IDs via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Partner Role Permissions corresponding to the given data fields.
/prm/api/objects/v1/PartnerRolePermission
Retrieve a list of partner role permissions matching the specified data fields 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 Partner Role Permissions corresponding to the given parameters.
/prm/api/objects/v1/PartnerRolePermission
Retrieve a list of partner role permissions 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 Partner Role Permission by id.
/prm/api/objects/v1/PartnerRolePermission/{id}
Retrieve details for a single partner role permission 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Partner Role Permission based on the specified view model.
/prm/api/objects/v1/PartnerRolePermission/{id}
Update an existing partner role permission identified by its ID 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 Partner Role Permissions based on the specified view models.
/prm/api/objects/v1/PartnerRolePermission
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. |
PartnerTransaction Admin API (8)
PUT Adds a single or many Partner Transactions based on the specified view model(s).
/api/objects/v1/PartnerTransaction
Create one or multiple partner transactions based on the provided view models using admin 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 Partner Transaction by id.
/api/objects/v1/PartnerTransaction/{id}
Permanently delete a specific partner transaction by its unique identifier using admin 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 Partner Transactions by id.
/api/objects/v1/PartnerTransaction
Permanently delete multiple partner transactions by their unique identifiers in a single admin 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 Partner Transactions corresponding to the given data fields.
/api/objects/v1/PartnerTransaction
Retrieve a list of partner transactions matching the criteria specified in the request body using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Partner Transactions corresponding to the given parameters.
/api/objects/v1/PartnerTransaction
Retrieve a list of partner transactions filtered by query parameters using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Partner Transaction by id.
/api/objects/v1/PartnerTransaction/{id}
Retrieve the details of a single partner transaction by its unique identifier using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Partner Transaction based on the specified view model.
/api/objects/v1/PartnerTransaction/{id}
Update specific fields of an existing partner transaction by its unique identifier using admin 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 Partner Transactions based on the specified view models.
/api/objects/v1/PartnerTransaction
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. |
PartnerTransaction Member API (8)
PUT Adds a single or many Partner Transactions based on the specified view model(s).
/prm/api/objects/v1/PartnerTransaction
Create one or multiple partner transactions based on the provided view models via 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 Partner Transaction by id.
/prm/api/objects/v1/PartnerTransaction/{id}
Delete a single partner transaction by its unique identifier via 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 Partner Transactions by id.
/prm/api/objects/v1/PartnerTransaction
Delete multiple partner transactions by their unique identifiers via 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 Partner Transactions corresponding to the given data fields.
/prm/api/objects/v1/PartnerTransaction
Retrieve a list of partner transactions matching the specified data fields via 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 Partner Transactions corresponding to the given parameters.
/prm/api/objects/v1/PartnerTransaction
Retrieve a list of partner transactions matching the specified query parameters via 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 Partner Transaction by id.
/prm/api/objects/v1/PartnerTransaction/{id}
Retrieve the details of a single partner transaction by its unique identifier via 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 Partner Transaction based on the specified view model.
/prm/api/objects/v1/PartnerTransaction/{id}
Update specific fields of an existing partner transaction by its unique identifier via 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 Partner Transactions based on the specified view models.
/prm/api/objects/v1/PartnerTransaction
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. |
PasswordRecoveryQuestion Admin API (3)
POST Gets a list of Password Recovery Questions corresponding to the given data fields.
/api/objects/v1/PasswordRecoveryQuestion
Retrieve a list of password recovery questions matching the criteria provided in the request body using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Password Recovery Questions corresponding to the given parameters.
/api/objects/v1/PasswordRecoveryQuestion
Retrieve a list of password recovery questions filtered by query parameters using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Password Recovery Question by id.
/api/objects/v1/PasswordRecoveryQuestion/{id}
Retrieve a single password recovery question by its unique identifier using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PasswordRecoveryQuestion Member API (3)
POST Gets a list of Password Recovery Questions corresponding to the given data fields.
/prm/api/objects/v1/PasswordRecoveryQuestion
Retrieve a list of password recovery questions 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 Password Recovery Questions corresponding to the given parameters.
/prm/api/objects/v1/PasswordRecoveryQuestion
Retrieve a list of password recovery questions 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 Password Recovery Question by id.
/prm/api/objects/v1/PasswordRecoveryQuestion/{id}
Retrieve a single password recovery question 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). |
PrivateOffer Admin API (4)
POST /api/objects/v1/PrivateOffer/_describeCloudProducts/{cloud}/{isvCloudAccountId}
/api/objects/v1/PrivateOffer/_describeCloudProducts/{cloud}/{isvCloudAccountId}
Retrieve descriptive details for cloud products associated with a specific cloud provider and ISV cloud 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 target cloud platform identifier or name. |
|
|
The unique identifier of the ISV cloud account. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of product identifiers to describe. |
GET /api/objects/v1/PrivateOffer/_listHyperscalerProducts/{cloud}/{isvCloudAccountId}
/api/objects/v1/PrivateOffer/_listHyperscalerProducts/{cloud}/{isvCloudAccountId}
Retrieve a sorted list of hyperscaler products for a given cloud platform and ISV cloud 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 target cloud platform identifier or name. |
|
|
The unique identifier of the ISV cloud account. |
|
|
Filter member KPIs starting from this date. |
|
|
Filter member KPIs up to this date. |
|
|
The product attribute to sort the results by. |
|
|
The order in which to sort the results, such as ascending or descending. |
|
|
The response format expected from the API (e.g. application/json). |
POST /api/objects/v1/PrivateOffer/_migrateProducts/{cloud}/{isvCloudAccountId}
/api/objects/v1/PrivateOffer/_migrateProducts/{cloud}/{isvCloudAccountId}
Migrate a specified list of products for a designated cloud platform and ISV cloud 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 target cloud platform identifier or name. |
|
|
The unique identifier of the ISV cloud account. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of products to migrate. |
GET /api/objects/v1/PrivateOffer/_searchMarketplaceProducts/{cloud}/{isvCloudAccountId}
/api/objects/v1/PrivateOffer/_searchMarketplaceProducts/{cloud}/{isvCloudAccountId}
Search for marketplace products within a specific cloud provider and ISV account using product identifiers.
Parameters
|
Parameter Name |
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 target cloud platform identifier or name. |
|
|
The unique identifier of the ISV cloud account. |
|
|
The Labra product identifier to search for. |
|
|
The cloud product identifier to search for. |
|
|
The response format expected from the API (e.g. application/json). |
PrivateOffer Member API (3)
POST /prm/api/objects/v1/PrivateOffer/_createWithToken
/prm/api/objects/v1/PrivateOffer/_createWithToken
Create a private offer using an authorization token, deal identifier, and cloud account 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 (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the deal associated with the offer. |
|
|
The target cloud platform identifier or name. |
|
|
The unique identifier of the ISV cloud account. |
GET /prm/api/objects/v1/PrivateOffer/_listHyperscalerProducts/{cloud}/{isvCloudAccountId}
/prm/api/objects/v1/PrivateOffer/_listHyperscalerProducts/{cloud}/{isvCloudAccountId}
Retrieve a list of hyperscaler products for a member based on cloud platform and ISV account settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The target cloud platform identifier or name. |
|
|
The unique identifier of the ISV cloud account. |
|
|
Filter member KPIs starting from this date. |
|
|
Filter member KPIs up to this date. |
|
|
The field name to sort the hyperscaler products by. |
|
|
The order to sort the results, such as ascending or descending. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/PrivateOffer/_searchMarketplaceProducts/{cloud}/{isvCloudAccountId}
/prm/api/objects/v1/PrivateOffer/_searchMarketplaceProducts/{cloud}/{isvCloudAccountId}
Search marketplace products as a member across a designated cloud platform and ISV 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 target cloud platform identifier or name. |
|
|
The unique identifier of the ISV cloud account. |
|
|
The Labra product identifier to filter search results. |
|
|
The cloud product identifier to filter search results. |
|
|
The response format expected from the API (e.g. application/json). |
Product Admin API (8)
PUT Adds a single or many Products based on the specified view model(s).
/api/objects/v1/Product
Create or update one or more products based on 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 Product by id.
/api/objects/v1/Product/{id}
Permanently delete a single product 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 Products by id.
/api/objects/v1/Product
Permanently delete multiple products 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 Products corresponding to the given data fields.
/api/objects/v1/Product
Retrieve a list of products matching the provided data fields using administrative permissions. Use this action when querying products based on complex filter criteria in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (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 Products corresponding to the given parameters.
/api/objects/v1/Product
Retrieve a list of products matching the specified query parameters with administrative permissions. Use this action to browse or search for products across the catalog.
Parameters
|
Parameter Name |
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 Product by id.
/api/objects/v1/Product/{id}
Retrieve details for a specific product by its unique identifier using administrative privileges. Use this action to view complete information for a single product.
Parameters
|
Parameter Name |
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 Product based on the specified view model.
/api/objects/v1/Product/{id}
Update an existing product's details based on the provided model using administrative privileges. Use this action to modify attributes of a specific product 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 Products based on the specified view models.
/api/objects/v1/Product
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. |
Product Member API (8)
PUT Adds a single or many Products based on the specified view model(s).
/prm/api/objects/v1/Product
Create or update one or multiple products using member-level permissions. Use this action to batch import or upsert product records in the partner 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 Product by id.
/prm/api/objects/v1/Product/{id}
Delete a specific product by its unique identifier using member-level permissions. Use this action to remove an individual product from the partner 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 Products by id.
/prm/api/objects/v1/Product
Delete multiple products by their unique identifiers using member-level permissions. Use this action to perform batch deletions of product 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 Products corresponding to the given data fields.
/prm/api/objects/v1/Product
Retrieve a list of products matching the specified data fields using member-level permissions. Use this action to search for partner-accessible products using request body criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Products corresponding to the given parameters.
/prm/api/objects/v1/Product
Retrieve a list of products matching the specified query parameters using member-level permissions. Use this action to browse or filter products available to the current member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Product by id.
/prm/api/objects/v1/Product/{id}
Retrieve details for a single product by its unique identifier using member-level permissions. Use this action to inspect an individual product record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Product based on the specified view model.
/prm/api/objects/v1/Product/{id}
Update an existing product's details using member-level permissions based on the provided model. Use this action to modify fields on a specific product.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/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 Products based on the specified view models.
/prm/api/objects/v1/Product
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. |
ProductCategory Admin API (8)
PUT Adds a single or many Product Categories based on the specified view model(s).
/api/objects/v1/ProductCategory
Create or update one or multiple product categories using administrative privileges. Use this action to define or batch update category classifications across the catalog.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 Product Category by id.
/api/objects/v1/ProductCategory/{id}
Delete a specific product category by its unique identifier using administrative privileges. Use this action to remove an individual category.
Parameters
|
Parameter Name |
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 Product Categories by id.
/api/objects/v1/ProductCategory
Delete multiple product categories by their identifiers using administrative privileges. Use this action to perform bulk deletion of product categories.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 Product Categories corresponding to the given data fields.
/api/objects/v1/ProductCategory
Retrieve a list of product categories matching the given data fields using administrative permissions. Use this action when querying categories using 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 (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 Product Categories corresponding to the given parameters.
/api/objects/v1/ProductCategory
Retrieve a list of product categories matching the specified query parameters using administrative permissions. Use this action to browse or search category 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 Product Category by id.
/api/objects/v1/ProductCategory/{id}
Retrieve details for a single product category by its unique identifier using administrative privileges. Use this action to inspect a category's configuration 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 Product Category based on the specified view model.
/api/objects/v1/ProductCategory/{id}
Update an existing product category based on the specified model using administrative privileges. Use this action to modify category attributes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Product Categories based on the specified view models.
/api/objects/v1/ProductCategory
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. |
ProductCategory Member API (8)
PUT Adds a single or many Product Categories based on the specified view model(s).
/prm/api/objects/v1/ProductCategory
Create or update one or multiple product categories using member-level permissions. Use this action to batch add or update categories within the partner 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 Product Category by id.
/prm/api/objects/v1/ProductCategory/{id}
Permanently delete a single product category identified by its unique 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Product Categories by id.
/prm/api/objects/v1/ProductCategory
Permanently delete multiple product categories in bulk via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Product Categories corresponding to the given data fields.
/prm/api/objects/v1/ProductCategory
Retrieve a list of product categories 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 (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 Product Categories corresponding to the given parameters.
/prm/api/objects/v1/ProductCategory
Retrieve a list of product categories 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 Product Category by id.
/prm/api/objects/v1/ProductCategory/{id}
Retrieve details of a single product category by its unique 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. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Product Category based on the specified view model.
/prm/api/objects/v1/ProductCategory/{id}
Update specific fields of an existing product category by ID 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 Product Categories based on the specified view models.
/prm/api/objects/v1/ProductCategory
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. |
Proposed_OEM__co Admin API (11)
PUT Adds a single or many Proposed OEMs based on the specified view model(s).
/api/objects/v1/Proposed_OEM__co
Create or replace one or more proposed OEM records using 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 Proposed OEM by id.
/api/objects/v1/Proposed_OEM__co/{id}
Permanently delete a single proposed OEM record by its unique ID 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 Proposed OEMs by id.
/api/objects/v1/Proposed_OEM__co
Permanently delete multiple proposed OEM records by their IDs via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Proposed OEMs based on the given data fields.
/api/objects/v1/Proposed_OEM__co/_export
Export proposed OEM records matching the criteria specified 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 Proposed OEMs based on the same get parameters.
/api/objects/v1/Proposed_OEM__co/_export
Export proposed OEM records based on standard filter 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 Proposed OEMs corresponding to the given data fields.
/api/objects/v1/Proposed_OEM__co
Retrieve a list of proposed OEM records matching the criteria provided in the request body via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Proposed OEMs corresponding to the given parameters.
/api/objects/v1/Proposed_OEM__co
Retrieve a list of proposed OEM records 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 Proposed OEM by id.
/api/objects/v1/Proposed_OEM__co/{id}
Retrieve the details of a single proposed OEM record by its unique ID 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 Proposed OEM.
/api/objects/v1/Proposed_OEM__co/_export/types
Retrieve the supported file and data export types available for proposed OEM records via the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Proposed OEM based on the specified view model.
/api/objects/v1/Proposed_OEM__co/{id}
Update specific fields of an existing proposed OEM record by ID 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 Proposed OEMs based on the specified view models.
/api/objects/v1/Proposed_OEM__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Proposed_OEM__co Member API (11)
PUT Adds a single or many Proposed OEMs based on the specified view model(s).
/prm/api/objects/v1/Proposed_OEM__co
Create or replace one or more proposed OEM records using 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 Proposed OEM by id.
/prm/api/objects/v1/Proposed_OEM__co/{id}
Permanently delete a single proposed OEM record by its unique 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Proposed OEMs by id.
/prm/api/objects/v1/Proposed_OEM__co
Permanently delete multiple proposed OEM records by their IDs via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Proposed OEMs based on the given data fields.
/prm/api/objects/v1/Proposed_OEM__co/_export
Export proposed OEM records based on criteria provided in the request body. Use this action to generate an export dataset using specific filter 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 (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 Proposed OEMs based on the same get parameters.
/prm/api/objects/v1/Proposed_OEM__co/_export
Export proposed OEM records using query parameters. Use this action to retrieve exported proposed OEM data without passing a request body.
Parameters
|
Parameter Name |
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 Proposed OEMs corresponding to the given data fields.
/prm/api/objects/v1/Proposed_OEM__co
Retrieve a list of proposed OEM records that match the filter criteria specified in the request body. Use this when complex query parameters are needed to search proposed OEMs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 Proposed OEMs corresponding to the given parameters.
/prm/api/objects/v1/Proposed_OEM__co
Retrieve a list of proposed OEM records matching the provided query parameters. Use this action for standard searches and listing of proposed OEMs.
Parameters
|
Parameter Name |
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 Proposed OEM by id.
/prm/api/objects/v1/Proposed_OEM__co/{id}
Retrieve the details of a specific proposed OEM record by its unique identifier. Use this action when you need the complete profile of a single proposed OEM.
Parameters
|
Parameter Name |
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 Proposed OEM.
/prm/api/objects/v1/Proposed_OEM__co/_export/types
Retrieve the available export file types and formats supported for proposed OEM records. Use this action before initiating an export to check valid export formats.
Parameters
|
Parameter Name |
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 Proposed OEM based on the specified view model.
/prm/api/objects/v1/Proposed_OEM__co/{id}
Update specific fields of an existing proposed OEM record by its unique identifier. Use this action to apply partial changes based on a 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 Proposed OEMs based on the specified view models.
/prm/api/objects/v1/Proposed_OEM__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Question Admin API (3)
POST Gets a list of Fields corresponding to the given data fields.
/api/objects/v1/Question
Retrieve a list of question fields matching criteria provided in the request body from the admin API. Use this action when filtering or searching administrative field configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (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 Fields corresponding to the given parameters.
/api/objects/v1/Question
Retrieve a list of question fields matching query parameters from the admin API. Use this action to browse or filter administrative field 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 Field by id.
/api/objects/v1/Question/{id}
Retrieve a single question field by its unique identifier using the admin API. Use this action to inspect the configuration and details of a specific field.
Parameters
|
Parameter Name |
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). |
Question Member API (3)
POST Gets a list of Fields corresponding to the given data fields.
/prm/api/objects/v1/Question
Retrieve a list of question fields matching criteria specified in the request body using the member API. Use this action to search available fields within a member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Fields corresponding to the given parameters.
/prm/api/objects/v1/Question
Retrieve a list of question fields using query parameters from the member API. Use this action to list field definitions 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. |
|
|
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 Field by id.
/prm/api/objects/v1/Question/{id}
Retrieve a single question field by its unique identifier through the member API. Use this action to look up details for a specific field within member scope.
Parameters
|
Parameter Name |
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). |
QuestionCategory Admin API (3)
POST Gets a list of Field Categories corresponding to the given data fields.
/api/objects/v1/QuestionCategory
Retrieve a list of field categories matching criteria provided in the request body using the admin API. Use this action to search or filter field categories with complex 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 Field Categories corresponding to the given parameters.
/api/objects/v1/QuestionCategory
Retrieve a list of field categories matching query parameters using the admin API. Use this action to browse available administrative field categories.
Parameters
|
Parameter Name |
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 Field Category by id.
/api/objects/v1/QuestionCategory/{id}
Retrieve a single field category by its unique identifier using the admin API. Use this action to view the details of a specific question category.
Parameters
|
Parameter Name |
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). |
QuestionCategory Member API (3)
POST Gets a list of Field Categories corresponding to the given data fields.
/prm/api/objects/v1/QuestionCategory
Retrieve a list of field categories matching criteria provided in the request payload using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Field Categories corresponding to the given parameters.
/prm/api/objects/v1/QuestionCategory
Retrieve a list of field categories matching specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Field Category by id.
/prm/api/objects/v1/QuestionCategory/{id}
Retrieve a specific field category 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). |
QuestionOption Admin API (3)
POST Gets a list of Field Options corresponding to the given data fields.
/api/objects/v1/QuestionOption
Retrieve a list of field options matching criteria provided in the request payload using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Field Options corresponding to the given parameters.
/api/objects/v1/QuestionOption
Retrieve a list of field options matching specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Field Option by id.
/api/objects/v1/QuestionOption/{id}
Retrieve a specific field option by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
QuestionOption Member API (3)
POST Gets a list of Field Options corresponding to the given data fields.
/prm/api/objects/v1/QuestionOption
Retrieve a list of field options matching criteria provided in the request payload using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Field Options corresponding to the given parameters.
/prm/api/objects/v1/QuestionOption
Retrieve a list of field options matching specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Field Option by id.
/prm/api/objects/v1/QuestionOption/{id}
Retrieve a specific field option by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
QuestionType Admin API (3)
POST Gets a list of Field Types corresponding to the given data fields.
/api/objects/v1/QuestionType
Retrieve a list of field types matching criteria provided in the request payload using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Field Types corresponding to the given parameters.
/api/objects/v1/QuestionType
Retrieve a list of field types matching specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Field Type by id.
/api/objects/v1/QuestionType/{id}
Retrieve a specific field type by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
QuestionType Member API (3)
POST Gets a list of Field Types corresponding to the given data fields.
/prm/api/objects/v1/QuestionType
Retrieve a list of field types matching criteria provided in the request payload using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Field Types corresponding to the given parameters.
/prm/api/objects/v1/QuestionType
Retrieve a list of field types matching specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Field Type by id.
/prm/api/objects/v1/QuestionType/{id}
Retrieve a specific field type 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). |
ReferralSettings Admin API (8)
PUT Adds a single or many Referral Settings based on the specified view model(s).
/api/objects/v1/ReferralSettings
Create or update one or more referral settings based on the provided view models 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 view model payload containing account details to add. |
DELETE Deletes a single Referral Setting by id.
/api/objects/v1/ReferralSettings/{id}
Permanently delete a specific referral setting by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Referral Settings by id.
/api/objects/v1/ReferralSettings
Permanently delete multiple referral settings by their identifiers 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 Gets a list of Referral Settings corresponding to the given data fields.
/api/objects/v1/ReferralSettings
Retrieve a list of referral settings based on data fields provided in the request body. Use this action in administrative workflows to query settings using complex filter 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 Referral Settings corresponding to the given parameters.
/api/objects/v1/ReferralSettings
Retrieve a list of referral settings matching specified query parameters. Use this action to browse or filter administrative referral settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 Referral Setting by id.
/api/objects/v1/ReferralSettings/{id}
Retrieve a single referral setting record by its unique identifier. Use this action in administrative workflows to view full configuration details of a specific setting.
Parameters
|
Parameter Name |
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 Referral Setting based on the specified view model.
/api/objects/v1/ReferralSettings/{id}
Update specific fields of an existing referral setting by its unique identifier. Use this action to modify administrative referral configuration without overwriting 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 Referral Settings based on the specified view models.
/api/objects/v1/ReferralSettings
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. |
ReferralSettings Member API (8)
PUT Adds a single or many Referral Settings based on the specified view model(s).
/prm/api/objects/v1/ReferralSettings
Create or replace one or multiple referral settings records through the member API. Use this action to publish or update referral configurations for portal members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Referral Setting by id.
/prm/api/objects/v1/ReferralSettings/{id}
Permanently remove a single referral setting record by its identifier using the member API. Use this action to delete obsolete member-facing referral settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Referral Settings by id.
/prm/api/objects/v1/ReferralSettings
Permanently delete multiple referral setting records in bulk through the member API. Use this action to clean up multiple member-facing settings 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 Referral Settings corresponding to the given data fields.
/prm/api/objects/v1/ReferralSettings
Retrieve a list of referral settings matching data fields sent in the request body through the member API. Use this action to perform targeted searches for member-accessible settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 Referral Settings corresponding to the given parameters.
/prm/api/objects/v1/ReferralSettings
Retrieve a list of member-facing referral settings matching query parameters. Use this action to fetch and display configured referral options in member workflows.
Parameters
|
Parameter Name |
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 Referral Setting by id.
/prm/api/objects/v1/ReferralSettings/{id}
Retrieve a single referral setting record by its unique identifier using the member API. Use this action to view individual setting details within a member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Referral Setting based on the specified view model.
/prm/api/objects/v1/ReferralSettings/{id}
Update specific fields of an existing referral setting by its identifier using the member API. Use this action to apply partial changes to a member-facing setting 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 Referral Settings based on the specified view models.
/prm/api/objects/v1/ReferralSettings
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. |
ReferralStatus Admin API (8)
PUT Adds a single or many Referral Status based on the specified view model(s).
/api/objects/v1/ReferralStatus
Create or replace one or more referral status records in the admin context. Use this action to add new referral workflow states or update existing ones in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Referral Status by id.
/api/objects/v1/ReferralStatus/{id}
Permanently delete a single referral status record by its unique identifier. Use this action in administrative workflows to remove an unused referral 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. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Referral Status by id.
/api/objects/v1/ReferralStatus
Permanently delete multiple referral status records by their identifiers. Use this action in administrative workflows to batch remove referral statuses.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 Referral Status corresponding to the given data fields.
/api/objects/v1/ReferralStatus
Retrieve a list of referral status records matching data fields provided in the request body. Use this action for administrative searches of referral lifecycle stages.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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 Referral Status corresponding to the given parameters.
/api/objects/v1/ReferralStatus
Retrieve a list of referral status records matching specified query parameters. Use this action to inspect available administrative referral statuses.
Parameters
|
Parameter Name |
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 Referral Status by id.
/api/objects/v1/ReferralStatus/{id}
Retrieve details of a single referral status record by its unique identifier. Use this action to inspect the properties of a specific administrative status stage.
Parameters
|
Parameter Name |
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 Referral Status based on the specified view model.
/api/objects/v1/ReferralStatus/{id}
Update specific fields of an existing referral status record by its identifier. Use this action to modify administrative referral status properties without replacing the entire entity.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/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 Referral Status based on the specified view models.
/api/objects/v1/ReferralStatus
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. |
ReferralStatus Member API (8)
PUT Adds a single or many Referral Status based on the specified view model(s).
/prm/api/objects/v1/ReferralStatus
Create or replace one or more referral status records using the member API. Use this action to manage referral status configurations accessible to portal members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Referral Status by id.
/prm/api/objects/v1/ReferralStatus/{id}
Permanently delete a single referral status 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 Referral Status by id.
/prm/api/objects/v1/ReferralStatus
Delete multiple referral status records simultaneously 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 Referral Status corresponding to the given data fields.
/prm/api/objects/v1/ReferralStatus
Retrieve a list of referral status records matching specified filter criteria and data fields using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Referral Status corresponding to the given parameters.
/prm/api/objects/v1/ReferralStatus
Retrieve a list of referral status records filtered by the specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Referral Status by id.
/prm/api/objects/v1/ReferralStatus/{id}
Retrieve the details of a single referral status 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 Referral Status based on the specified view model.
/prm/api/objects/v1/ReferralStatus/{id}
Update specific fields of an existing referral status 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 Referral Status based on the specified view models.
/prm/api/objects/v1/ReferralStatus
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. |
ReferralStatusMapping Admin API (8)
PUT Adds a single or many Referral Status Mappings based on the specified view model(s).
/api/objects/v1/ReferralStatusMapping
Create or replace one or more referral status mappings 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 view model payload containing account details to add. |
DELETE Deletes a single Referral Status Mapping by id.
/api/objects/v1/ReferralStatusMapping/{id}
Permanently delete a single referral status mapping by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Referral Status Mappings by id.
/api/objects/v1/ReferralStatusMapping
Delete multiple referral status mappings simultaneously 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 Gets a list of Referral Status Mappings corresponding to the given data fields.
/api/objects/v1/ReferralStatusMapping
Retrieve a list of referral status mappings matching specified filter criteria and data fields using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Referral Status Mappings corresponding to the given parameters.
/api/objects/v1/ReferralStatusMapping
Retrieve a list of referral status mappings filtered by the specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Referral Status Mapping by id.
/api/objects/v1/ReferralStatusMapping/{id}
Retrieve the details of a single referral status mapping by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Referral Status Mapping based on the specified view model.
/api/objects/v1/ReferralStatusMapping/{id}
Update specific fields of an existing referral status mapping by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Referral Status Mappings based on the specified view models.
/api/objects/v1/ReferralStatusMapping
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. |
ReferralStatusMapping Member API (8)
PUT Adds a single or many Referral Status Mappings based on the specified view model(s).
/prm/api/objects/v1/ReferralStatusMapping
Create or replace one or more referral status mappings 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 Referral Status Mapping by id.
/prm/api/objects/v1/ReferralStatusMapping/{id}
Permanently delete a single referral status mapping 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 Referral Status Mappings by id.
/prm/api/objects/v1/ReferralStatusMapping
Delete multiple referral status mappings simultaneously 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 Referral Status Mappings corresponding to the given data fields.
/prm/api/objects/v1/ReferralStatusMapping
Retrieve a list of referral status mappings matching specified filter criteria and data fields using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Referral Status Mappings corresponding to the given parameters.
/prm/api/objects/v1/ReferralStatusMapping
Retrieve a list of referral status mappings filtered by the specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Referral Status Mapping by id.
/prm/api/objects/v1/ReferralStatusMapping/{id}
Retrieve the details of a single referral status mapping 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 Referral Status Mapping based on the specified view model.
/prm/api/objects/v1/ReferralStatusMapping/{id}
Update specific fields of an existing referral status mapping 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 Referral Status Mappings based on the specified view models.
/prm/api/objects/v1/ReferralStatusMapping
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. |
Region Admin API (3)
POST Gets a list of Regions corresponding to the given data fields.
/api/objects/v1/Region
Retrieve a list of regions matching the provided data fields using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Regions corresponding to the given parameters.
/api/objects/v1/Region
Retrieve a list of regions filtered by the specified 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 Region by id.
/api/objects/v1/Region/{id}
Retrieve details for a single region 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). |
Region Member API (3)
POST Gets a list of Regions corresponding to the given data fields.
/prm/api/objects/v1/Region
Retrieve a list of regions matching the provided data fields using 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 Regions corresponding to the given parameters.
/prm/api/objects/v1/Region
Retrieve a list of regions filtered by the specified parameters using 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 Region by id.
/prm/api/objects/v1/Region/{id}
Retrieve details for a single region by its unique identifier using 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). |
Sale Admin API (8)
PUT Adds a single or many Sales based on the specified view model(s).
/api/objects/v1/Sale
Create or insert one or more sale records based on the provided view models using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Sale by id.
/api/objects/v1/Sale/{id}
Delete a specific sale record 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Sales by id.
/api/objects/v1/Sale
Delete multiple sale records by their identifiers using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Sales corresponding to the given data fields.
/api/objects/v1/Sale
Retrieve a list of sales matching the provided data fields using administrative access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Sales corresponding to the given parameters.
/api/objects/v1/Sale
Retrieve a list of sales filtered by the specified 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 Sale by id.
/api/objects/v1/Sale/{id}
Retrieve details for a single sale record 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 Sale based on the specified view model.
/api/objects/v1/Sale/{id}
Update an existing sale record using the provided view model and 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 Sales based on the specified view models.
/api/objects/v1/Sale
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. |
Sale Member API (8)
PUT Adds a single or many Sales based on the specified view model(s).
/prm/api/objects/v1/Sale
Create or insert one or more sale records based on the provided view models using 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Sale by id.
/prm/api/objects/v1/Sale/{id}
Delete a specific sale record by its unique identifier using 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 |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Sales by id.
/prm/api/objects/v1/Sale
Delete multiple sale records by their identifiers using 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 (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Sales corresponding to the given data fields.
/prm/api/objects/v1/Sale
Retrieve a list of sales matching the provided data fields using 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 Sales corresponding to the given parameters.
/prm/api/objects/v1/Sale
Retrieve a list of sales filtered by the specified parameters using 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 Sale by id.
/prm/api/objects/v1/Sale/{id}
Retrieve details for a specific sale record by its unique identifier using 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 |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Sale based on the specified view model.
/prm/api/objects/v1/Sale/{id}
Update specific fields of an existing sale record using 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 Sales based on the specified view models.
/prm/api/objects/v1/Sale
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. |
SaleProduct Admin API (8)
PUT Adds a single or many Product (Sale) based on the specified view model(s).
/api/objects/v1/SaleProduct
Create or replace one or more sale product 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 Product (Sale) by id.
/api/objects/v1/SaleProduct/{id}
Permanently delete a specific sale product 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 Product (Sale) by id.
/api/objects/v1/SaleProduct
Permanently delete multiple sale product 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 Product (Sale) corresponding to the given data fields.
/api/objects/v1/SaleProduct
Retrieve a list of sale product records matching criteria submitted in the request body with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Product (Sale) corresponding to the given parameters.
/api/objects/v1/SaleProduct
Retrieve a list of sale product records matching the provided query parameters with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Product (Sale) by id.
/api/objects/v1/SaleProduct/{id}
Retrieve details for a single sale product record by its unique identifier with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Product (Sale) based on the specified view model.
/api/objects/v1/SaleProduct/{id}
Update specific fields of an existing sale product record by its unique identifier 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 Product (Sale) based on the specified view models.
/api/objects/v1/SaleProduct
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. |
SaleProduct Member API (8)
PUT Adds a single or many Product (Sale) based on the specified view model(s).
/prm/api/objects/v1/SaleProduct
Create or replace one or more sale product records using 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 view model payload containing account details to add. |
DELETE Deletes a single Product (Sale) by id.
/prm/api/objects/v1/SaleProduct/{id}
Permanently delete a single sale product record by its unique identifier using 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 Product (Sale) by id.
/prm/api/objects/v1/SaleProduct
Permanently delete multiple sale product records by their identifiers using 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. |
POST Gets a list of Product (Sale) corresponding to the given data fields.
/prm/api/objects/v1/SaleProduct
Retrieve a list of sale product records matching criteria submitted in the request body using 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 (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 Product (Sale) corresponding to the given parameters.
/prm/api/objects/v1/SaleProduct
Retrieve a list of sale product records matching the provided query parameters using 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. |
|
|
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 Product (Sale) by id.
/prm/api/objects/v1/SaleProduct/{id}
Retrieve details for a single sale product record by its unique identifier using 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 |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Product (Sale) based on the specified view model.
/prm/api/objects/v1/SaleProduct/{id}
Update specific fields of an existing sale product record by its unique identifier using 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 Product (Sale) based on the specified view models.
/prm/api/objects/v1/SaleProduct
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. |
Sales Admin API
GET Summaries this instance.
/api/objects/v1/sales/_summary
Retrieve summary metrics and aggregate statistics for sales records with 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. |
|
|
The response format expected from the API (e.g. application/json). |
Sales Member API
GET Summaries this instance.
/prm/api/objects/v1/sales/_summary
Retrieve summary metrics and aggregate statistics for sales records accessible to the member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Solution Admin API (9)
GET /api/objects/v1/Solution/{id}/_view
/api/objects/v1/Solution/{id}/_view
Retrieve the view layout and display details for a specific solution record with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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 Solutions based on the specified view model(s).
/api/objects/v1/Solution
Create or replace one or more solution 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 Solution by id.
/api/objects/v1/Solution/{id}
Permanently delete a specific solution 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 Solutions by id.
/api/objects/v1/Solution
Permanently delete multiple solution records at once using an admin context. Use this action to remove batches of solutions 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 Solutions corresponding to the given data fields.
/api/objects/v1/Solution
Retrieve a list of solution records that match complex filter criteria or payload data fields. Use this action when searching for solutions with field-specific queries from an admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Solutions corresponding to the given parameters.
/api/objects/v1/Solution
Retrieve a list of solution records matching the specified query parameters. Use this action to browse or filter solutions in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Solution by id.
/api/objects/v1/Solution/{id}
Retrieve details for a specific solution record by its unique identifier. Use this action to fetch comprehensive administrative details for a single solution.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Solution based on the specified view model.
/api/objects/v1/Solution/{id}
Update specific fields of an existing solution record based on the provided view model. Use this action to apply partial updates to a single solution in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Solutions based on the specified view models.
/api/objects/v1/Solution
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Solution Member API
GET /prm/api/objects/v1/Solution/{id}/_view
/prm/api/objects/v1/Solution/{id}/_view
Retrieve the view representation of a single solution record. Use this action to inspect layout or UI-specific solution data in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
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). |