### GET /api/v1.0.0/system/serversettings Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires Administrator role. ```markdown ### Parameters - **settingNames** (string, query, optional): optional, comma separated list of setting names ### Responses #### 200 - Success #### 403 - Forbidden **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/system/serversettings?settingNames=string" ``` ``` -------------------------------- ### GET /api/v1.0.0/system/environmentcontext Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success **EnvironmentContext** - **customerSafeName** (string) - **environmentSafeName** (string) **EnvironmentContext** **EnvironmentContext** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/system/environmentcontext" ``` ``` -------------------------------- ### GET /api/v1.0.0/system/imageconfigurations Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of string - Array of string - Array of string ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/system/imageconfigurations" ``` ``` -------------------------------- ### GET /api/v1.0.0/system/imageconfigurationdetails Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of ImageConfigurationDetailsModel - Array of ImageConfigurationDetailsModel - Array of ImageConfigurationDetailsModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/system/imageconfigurationdetails" ``` ``` -------------------------------- ### GET /api/v1.0.0/syndications Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires Administrator role. ```markdown ### Responses #### 200 - Success - Array of SyndicationModel - Array of SyndicationModel - Array of SyndicationModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/syndications" ``` ``` -------------------------------- ### GET /api/v1.0.0/workareafolder/topnode Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires Administrator role. ```markdown ### Responses #### 200 - Success - Array of WorkareaFolderModel - Array of WorkareaFolderModel - Array of WorkareaFolderModel #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/workareafolder/topnode" ``` ``` -------------------------------- ### GET /api/v1.0.0/model/specificationtemplates Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of EntitySummaryModel - Array of EntitySummaryModel - Array of EntitySummaryModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/model/specificationtemplates" ``` ``` -------------------------------- ### GET /api/v1.0.0/packages Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Responses #### 200 - Success - Array of PackageModel - Array of PackageModel - Array of PackageModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/packages" ``` ``` -------------------------------- ### GET /api/v1.0.0/channels/queue Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of ChannelMessageModel - Array of ChannelMessageModel - Array of ChannelMessageModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/channels/queue" ``` ``` -------------------------------- ### GET /api/v1.0.0/system/users Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires APIManageUsers and View permissions. ```markdown ### Responses #### 200 - Success - Array of UserSegmentRolesModel - Array of UserSegmentRolesModel - Array of UserSegmentRolesModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/system/users" ``` ``` -------------------------------- ### GET /api/v1.0.0/HtmlTemplate Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **includeData** (boolean, query, optional) ### Responses #### 200 - Success - Array of HtmlTemplateModel - Array of HtmlTemplateModel - Array of HtmlTemplateModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/HtmlTemplate?includeData=true" ``` ``` -------------------------------- ### GET /api/v1.0.0/HtmlTemplate/type Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **contentStoreHtmlTemplateTypes** (array (string), query, optional): Supports the following values: "EnrichPDFTemplate", "EnrichPreviewTemplate", "PlanReleasePreviewTemplate", "EditTemplate", "ApplicationTemplate", "PortalTemplate", "ContentStoreTemplate", "ContentStoreCoverPage", "ContentStoreEndPage". - **includeData** (boolean, query, optional) ### Responses #### 200 - Success - Array of HtmlTemplateModel - Array of HtmlTemplateModel - Array of HtmlTemplateModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/HtmlTemplate/type?contentStoreHtmlTemplateTypes=item1,item2&includeData=true" ``` ``` -------------------------------- ### GET /api/v1.0.0/linkrules Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permissions. ```markdown ### Responses #### 200 - Success - Array of LinkRuleDefinitionModel - Array of LinkRuleDefinitionModel - Array of LinkRuleDefinitionModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/linkrules" ``` ``` -------------------------------- ### GET /api/v1.0.0/extensions/queue Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Parameters - **pageNumber** (integer (int32), query, optional): The page number (optional, defaults to 1). - **pageSize** (integer (int32), query, optional): The size of the page (optional, defaults to 50). ### Responses #### 200 - Success - Array of ConnectMessageModel - Array of ConnectMessageModel - Array of ConnectMessageModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/extensions/queue?pageNumber=1&pageSize=50" ``` ``` -------------------------------- ### GET /api/v1.0.0/system/users/{username} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires APIManageUsers and View permissions. ```markdown ### Parameters - **username** (string, path, required) ### Responses #### 200 - Success **UserSegmentRolesModel** - **username** (string) - **email** (string) - **firstName** (string) - **lastName** (string) - **segmentRoles** (array (SegmentRoleNamesModel)) Array items: - **segmentId** (integer (int32)) - **roleNames** (array (string)) **UserSegmentRolesModel** **UserSegmentRolesModel** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/system/users/{username}" ``` ``` -------------------------------- ### GET /api/v1.0.0/extensions/connectorstates Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Responses #### 200 - Success - Array of ConnectorStateModel - Array of ConnectorStateModel - Array of ConnectorStateModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/extensions/connectorstates" ``` ``` -------------------------------- ### GET /api/v1.0.0/channels Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **forEntityId** (integer (int32), query, optional): optional - **includeChannels** (boolean, query, optional): optional, defaults to true - **includePublications** (boolean, query, optional): optional, defaults to false ### Responses #### 200 - Success - Array of ChannelSummaryModel - Array of ChannelSummaryModel - Array of ChannelSummaryModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/channels?forEntityId=0&includeChannels=true&includePublications=false" ``` ``` -------------------------------- ### GET /api/v1.0.0/workareafolderquery/{id} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires Administrator role. ```markdown ### Parameters - **id** (string, path, required): required ### Responses #### 200 - Success **WorkAreaQueryModel** - **id** (string) - **name** (string) - **parentId** (string (uuid)) - **isQuery** (boolean) - **query** (object) - **systemCriteria** (array (SystemCriterionModel)) Array items: - **type** (string) - **value** (unknown) - **operator** (string) - **dataCriteria** (array (DataCriterionModel)) Array items: - **fieldTypeId** (string) - **value** (unknown) - **language** (string) - **operator** (string) - **linkCriterion** (object) - **linkTypeId** (string) - **direction** (string) - **linkExists** (boolean) - **dataCriteria** (array (DataCriterionModel)) Array items: - **dataCriteriaOperator** (string): Default value is "And". Accepts only "And" and "Or". - **index** (integer (int32)) **WorkAreaQueryModel** **WorkAreaQueryModel** #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/workareafolderquery/{id}" ``` ``` -------------------------------- ### GET /api/v1.0.0/workareafolder/topnode/{workareaFolderId} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires Administrator role. ```markdown ### Parameters - **workareaFolderId** (string, path, required) ### Responses #### 200 - Success **WorkareaFolderModel** - **id** (string) - **name** (string) - **isQuery** (boolean) - **isWorkflowQuery** (boolean) - **index** (integer (int32)) **WorkareaFolderModel** **WorkareaFolderModel** #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/workareafolder/topnode/{workareaFolderId}" ``` ``` -------------------------------- ### GET /api/v1.0.0/HtmlTemplate/{id} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **id** (integer (int32), path, required) ### Responses #### 200 - Success **HtmlTemplateModel** - **id** (integer (int32)) - **name** (string) - **localizedName** (object) - **templateType** (string) - **content** (string) - **properties** (string) **HtmlTemplateModel** **HtmlTemplateModel** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/HtmlTemplate/{id}" ``` ``` -------------------------------- ### GET /api/v1.0.0/packages/{packageId} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Parameters - **packageId** (integer (int32), path, required): The unique PackageId. ### Responses #### 200 - Success **PackageModel** - **id** (integer (int32)) - **createdDate** (string) - **modifiedDate** (string) - **fileName** (string) - **version** (integer (int32)) **PackageModel** **PackageModel** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/packages/{packageId}" ``` ``` -------------------------------- ### GET /api/v1.0.0/extensions/error Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Parameters - **pageNumber** (integer (int32), query, optional): The page number (optional, defaults to 1). - **pageSize** (integer (int32), query, optional): The size of the page (optional, defaults to 50). ### Responses #### 200 - Success - Array of ConnectMessageModel - Array of ConnectMessageModel - Array of ConnectMessageModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/extensions/error?pageNumber=1&pageSize=50" ``` ``` -------------------------------- ### GET /api/v1.0.0/extensions Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Responses #### 200 - Success - Array of ExtensionModel - Array of ExtensionModel - Array of ExtensionModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/extensions" ``` ``` -------------------------------- ### GET /api/v1.0.0/model/cvls/{cvlId} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **cvlId** (string, path, required) ### Responses #### 200 - Success **CVLModel** - **id** (string) - **parentId** (string) - **dataType** (string) - **customValueList** (boolean) **CVLModel** **CVLModel** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/model/cvls/{cvlId}" ``` ``` -------------------------------- ### GET /api/v1.0.0/extensions/queue/count Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Responses #### 200 - Success ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/extensions/queue/count" ``` ``` -------------------------------- ### GET /api/v1.0.0/extensions/connectorstates/{connectorId} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Parameters - **connectorId** (string, path, required): Connector ID ### Responses #### 200 - Success - Array of ConnectorStateModel - Array of ConnectorStateModel - Array of ConnectorStateModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/extensions/connectorstates/{connectorId}" ``` ``` -------------------------------- ### GET /api/v1.0.0/entities/{entityId}/media Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **entityId** (integer (int32), path, required) ### Responses #### 200 - Success - Array of string - Array of string - Array of string #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/entities/{entityId}/media" ``` ``` -------------------------------- ### GET /api/v1.0.0/entities/{entityId}/completenessdetails Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **entityId** (integer (int32), path, required) ### Responses #### 200 - Success **CompletenessDetailsModel** - **completeness** (integer (int32)) - **groups** (array (CompletenessGroupDetailsModel)) Array items: - **name** (string) - **isCompleted** (boolean) - **rules** (array (CompletenessRuleDetailModel)) Array items: - **name** (string) - **isCompleted** (boolean) **CompletenessDetailsModel** **CompletenessDetailsModel** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/entities/{entityId}/completenessdetails" ``` ``` -------------------------------- ### POST /api/v1.0.0/extensions Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission.

**extensionId**: The Unique ID of your new extension. The basic restrictions are: * Maximum length 50 characters Best practice * Use character set A to Z, a to z, 0-9. * Characters such as spaces, underscores, hyphens, etc. should not be used. **extensionType**: State the type of extension you have created. Valid values: * ChannelListener * CompletenessCriteria * CompletenessListener * CustomValueList * CVLListener * EntityListener * InboundDataExtension * InboundFileExtension * LinkListener * PrintFormatter * PrintImageCustomAttribute * PrintTextCustomAttribute * ScheduledExtension * ServerExtension * SpecificationListener * SyndicationExtension **assemblyName**: Write the full name of the assembly that contains your extension's class. **packageId**: You need to upload a package /packages:uploadbase64 before a new extension can be created. It will also return a package ID. Or fetch the package ID via endpoint /packages. **assemblyType**: The type including the namespace of the extension's class. It should be in the format "namespace"."class name". An example would be MyCompany.inRiver.Connectors.Outbound.EpiServerChannelListener for the EpiServerChannelListener in the MyCompany.inRiver.Connectors.Outbound namespace. This field is case sensitive. Casing must match your namespace and class exactly. ```markdown ### Request Body **Content-Type:** application/json-patch+json - **assemblyName** (string) - **assemblyType** (string) - **extensionId** (string) - **extensionType** (string) - **packageId** (integer (int32)) - **isEnabled** (boolean) - **extensionDescription** (string) **Content-Type:** application/json - **assemblyName** (string) - **assemblyType** (string) - **extensionId** (string) - **extensionType** (string) - **packageId** (integer (int32)) - **isEnabled** (boolean) - **extensionDescription** (string) **Content-Type:** text/json - **assemblyName** (string) - **assemblyType** (string) - **extensionId** (string) - **extensionType** (string) - **packageId** (integer (int32)) - **isEnabled** (boolean) - **extensionDescription** (string) **Content-Type:** application/*+json - **assemblyName** (string) - **assemblyType** (string) - **extensionId** (string) - **extensionType** (string) - **packageId** (integer (int32)) - **isEnabled** (boolean) - **extensionDescription** (string) ### Responses #### 200 - Success **ExtensionModel** - **extensionId** (string) - **extensionType** (string) - **assemblyName** (string) - **assemblyType** (string) - **status** (object) - **isEnabled** (boolean) - **isPaused** (boolean) - **package** (object) - **id** (integer (int32)) - **createdDate** (string) - **modifiedDate** (string) - **fileName** (string) - **version** (integer (int32)) - **extensionDescription** (string) **ExtensionModel** **ExtensionModel** #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/extensions" \ -H "Content-Type: application/json" \ -d '{ "assemblyName": "string", "assemblyType": "string", "extensionId": "string", "extensionType": "string", "packageId": "0", "isEnabled": "true", "extensionDescription": "string" }' ``` ``` -------------------------------- ### GET /api/v1.0.0/extensions/{extensionId}/settings/{key} Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission.
Get extension setting by passing the extensions id (extensionId) and the setting key (key) to the api endpoint. ```markdown ### Parameters - **extensionId** (string, path, required): The extensions id. - **key** (string, path, required): The extension setting key. ### Responses #### 200 - Success **ExtensionSettingModel** - **key** (string) - **value** (string) **ExtensionSettingModel** **ExtensionSettingModel** #### 401 - Unauthorized **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/extensions/{extensionId}/settings/{key}" ``` ``` -------------------------------- ### POST /api/v1.0.0/packages:uploadbase64 Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission.
Upload base64 encoded file data. To create a package, zip all the files in your build directory including your compiled code and all referenced assemblies. The .zip file must be uploaded via endpoint /packages:uploadbase64 before a new extension can be created. Once uploaded, fetch the the package ID via endpoint /packages. Best practice is to include the version in the .zip file name. For example OutboundConnector.2.12.6.zip ```markdown ### Request Body **Content-Type:** application/json-patch+json - **fileName** (string) - **data** (string) **Content-Type:** application/json - **fileName** (string) - **data** (string) **Content-Type:** text/json - **fileName** (string) - **data** (string) **Content-Type:** application/*+json - **fileName** (string) - **data** (string) ### Responses #### 200 - Success **PackageModel** - **id** (integer (int32)) - **createdDate** (string) - **modifiedDate** (string) - **fileName** (string) - **version** (integer (int32)) **PackageModel** **PackageModel** #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/packages:uploadbase64" \ -H "Content-Type: application/json" \ -d '{ "fileName": "string", "data": "string" }' ``` ``` -------------------------------- ### POST /api/v1.0.0/system/serversetting Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires ManageServerSettings and View permissions.
It returns only the settings that were updated. ```markdown ### Request Body **Content-Type:** application/json-patch+json **Content-Type:** application/json **Content-Type:** text/json **Content-Type:** application/*+json ### Responses #### 200 - Success #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/system/serversetting" \ -H "Content-Type: application/json" \ -d '"value"' ``` ``` -------------------------------- ### POST /api/v1.0.0/entities/{entityId}/media:uploadfromurl Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View, AddFile, UpdateEntity, either AddEntity or CopyEntity, and AddLink permissions.
Enter entityId for the entity you want to link the created resource entity to.
Example: You want to create a resource and then link it to a Product. You add the entityId for the product entity that you would like to link the resource entity to.
Note: If overrideUrlFileName is omitted, the filename will equal the one supplied in the url. Set overrideUrlFileName to specify a file name. ```markdown ### Parameters - **entityId** (integer (int32), path, required) ### Request Body **Content-Type:** application/json-patch+json - **url** (string) - **overrideUrlFileName** (string) **Content-Type:** application/json - **url** (string) - **overrideUrlFileName** (string) **Content-Type:** text/json - **url** (string) - **overrideUrlFileName** (string) **Content-Type:** application/*+json - **url** (string) - **overrideUrlFileName** (string) ### Responses #### 200 - Success **MediaInfoModel** - **fileId** (integer (int32)) - **url** (string) - **fileName** (string) - **extension** (string) - **fileSize** (integer (int64)) - **dateCreated** (string) - **lastModified** (string) - **entityId** (integer (int32)) **MediaInfoModel** **MediaInfoModel** #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/entities/{entityId}/media:uploadfromurl" \ -H "Content-Type: application/json" \ -d '{ "url": "string", "overrideUrlFileName": "string" }' ``` ``` -------------------------------- ### GET /api/v1.0.0/model/linktype Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of LinkTypeModel - Array of LinkTypeModel - Array of LinkTypeModel #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/model/linktype" ``` ``` -------------------------------- ### POST /api/v1.0.0/packages/{packageId}:uploadandreplacebase64 Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission.
Note that after you have uploaded a new version of a package you need to extensionmanager:restartservice to make sure the new extension is loaded instead of the old extension, or remove the extension and add it again. Best practice is to disable or pause extensions before you do an extensionmanager:restartservice to make sure you keep all messages and then enable / resume the extensions. Also note that scheduled extensions will be restarted. ```markdown ### Parameters - **packageId** (integer (int32), path, required): The unique PackageId. ### Request Body **Content-Type:** application/json-patch+json - **fileName** (string) - **data** (string) **Content-Type:** application/json - **fileName** (string) - **data** (string) **Content-Type:** text/json - **fileName** (string) - **data** (string) **Content-Type:** application/*+json - **fileName** (string) - **data** (string) ### Responses #### 200 - Success **PackageModel** - **id** (integer (int32)) - **createdDate** (string) - **modifiedDate** (string) - **fileName** (string) - **version** (integer (int32)) **PackageModel** **PackageModel** #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/packages/{packageId}:uploadandreplacebase64" \ -H "Content-Type: application/json" \ -d '{ "fileName": "string", "data": "string" }' ``` ``` -------------------------------- ### GET /api/v1.0.0/model/cvls Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of CVLModel - Array of CVLModel - Array of CVLModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/model/cvls" ``` ``` -------------------------------- ### POST /api/v1.0.0/extensions/{extensionId}/settings:applydefaults Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Parameters - **extensionId** (string, path, required) ### Responses #### 200 - Success - Array of ExtensionSettingModel - Array of ExtensionSettingModel - Array of ExtensionSettingModel #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** #### 500 - Server Error Server Error ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/extensions/{extensionId}/settings:applydefaults" ``` ``` -------------------------------- ### GET /api/v1.0.0/model/category Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of CategoryModel - Array of CategoryModel - Array of CategoryModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/model/category" ``` ``` -------------------------------- ### GET /api/v1.0.0/model/fieldsets Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of FieldSetModel - Array of FieldSetModel - Array of FieldSetModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/model/fieldsets" ``` ``` -------------------------------- ### POST /api/v1.0.0/entities/{entityId}/media:addexternalurl Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View, AddFile, UpdateEntity, either AddEntity or CopyEntity, and AddLink permissions.
Enter entityId for the entity you want to link the created resource entity to.
Example:
You want to create a resource and then link it to a Product. You add the entityId for the product entity that you would like to link the resource entity to.
Original external file URL that is added with this REST endpoint https://yourexternalresourceservice.com/imagename.jpg
Your external image service then need to support the standard inRiver image configuration formats(Original, Preview, Thumbnail and SmallThumbnail) as a suffix on the URL that you uploaded or have a proxy that redirect to the right image format, else the inRiver web portal will not work correct. https://yourexternalresourceservice.com/imagename.jpg/Original
https://yourexternalresourceservice.com/imagename.jpg/Preview
https://yourexternalresourceservice.com/imagename.jpg/Thumbnail
https://yourexternalresourceservice.com/imagename.jpg/SmallThumbnail
```markdown ### Parameters - **entityId** (integer (int32), path, required) ### Request Body **Content-Type:** application/json-patch+json - **url** (string) - **overrideUrlFileName** (string) **Content-Type:** application/json - **url** (string) - **overrideUrlFileName** (string) **Content-Type:** text/json - **url** (string) - **overrideUrlFileName** (string) **Content-Type:** application/*+json - **url** (string) - **overrideUrlFileName** (string) ### Responses #### 200 - Success **MediaInfoModel** - **fileId** (integer (int32)) - **url** (string) - **fileName** (string) - **extension** (string) - **fileSize** (integer (int64)) - **dateCreated** (string) - **lastModified** (string) - **entityId** (integer (int32)) **MediaInfoModel** **MediaInfoModel** #### 400 - Bad Request **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/entities/{entityId}/media:addexternalurl" \ -H "Content-Type: application/json" \ -d '{ "url": "string", "overrideUrlFileName": "string" }' ``` ``` -------------------------------- ### Schema: RunningExtensionModel Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Model for running extension ```markdown ## Schema: RunningExtensionModel Model for running extension **Type:** object - **isRunning** (boolean): If the extension is running ``` -------------------------------- ### GET /api/v1.0.0/model/languages Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Responses #### 200 - Success - Array of LanguageModel - Array of LanguageModel - Array of LanguageModel ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.0/model/languages" ``` ``` -------------------------------- ### GET /api/v1.0.1/model/entitytypes Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View permission. ```markdown ### Parameters - **entityTypeIds** (string, query, optional): optional, filter types using comma separated list ### Responses #### 200 - Success - Array of EntityTypeModelV2 - Array of EntityTypeModelV2 - Array of EntityTypeModelV2 ### Example Usage ```bash curl -X GET "https://api.example.com/api/v1.0.1/model/entitytypes?entityTypeIds=string" ``` ``` -------------------------------- ### POST /api/v1.0.0/dsa/insights Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Fetch basic, essential and premium datapoints directly from Evaluate DSA. This endpoint accepts an array of entity data parameters. **Parameters:** **fields: [optional]**
* An optional object for the list of properties to be fetched from the database. To retrieve extras fields, use `extras_product` as a parameter. To retrieve all essential fields, use `essential_all` or use dot (.) notation for specific fields. Same with premium, use `premium_all` to retrieve all or dot (.) notation for specific premium fields. -
Example:
"fields": [
...."item_id",
...."product_name",
...."extras_product",
...."essential.in_stock",
...."premium_all",
........
] **filters: [optional]** * An optional object of key-value pairs (field name and value) to filter the data. Only basic info and extras fields can be used for filter.
To filter extras properties, indicate the inner field itself (e.g. `extra_field_1`). To filter pim_id properties, use the dot (.) notation (e.g. `pim_id.item_entity_id`). Filters object can also accept multiple values in a field as long as it is within an array.
Example:
"filters": {
...."brand": "Sample",
...."website_name": ["retailer.com", "retailer2.com"],
...."product_group": "Sample Group",
...."model_number": "SAMPLE-1234",
...."pim_id.item_entity_id": ["12345", "6789"]
...."pim_id.retailer_id": [18, 45, 36]
.......
} **sort: [optional]** * An optional object with key-value pairs (field name and asc|desc) to order the data. Only one field can be sorted at a time.
Only basic info fields can be used for sorting. Basic info fields include `brand`, `website_name`, `website_url`, `product_group`, `country_code`, `currency_code`, `item_id`, and `product_name`
Example:
"sort": {
...."product_name": "desc"
} **navigation: [optional]** * An optional object with page and limit properties to manage pagination. By default, page is set to 1 and limit is set to 1000. Max limit is 1000, any limit set beyond this will be set back to 1000.
Example:
"navigation": {
...."page": 2,
...."limit": 500
}
**Requesting fewer objects will help reduce response time.** Example:
{
...."fields": [
......."brand",
......."product_name",
......."essential_all"
....],
...."filters": {
......."brand": [
........."Brand X",
........."Brand Y",
........."Brand Z"
.......],
......."product_group": "Plumbing",
....},
...."navigation": {
......."limit": 20
....},
...."sort": {
......."brand": "asc"
....}
} ```markdown ### Request Body **Content-Type:** application/json-patch+json - **fields** (array (string)) - **filters** (object) - **sort** (object) - **navigation** (object) - **page** (integer (int32)) - **limit** (integer (int32)) **Content-Type:** application/json - **fields** (array (string)) - **filters** (object) - **sort** (object) - **navigation** (object) - **page** (integer (int32)) - **limit** (integer (int32)) **Content-Type:** text/json - **fields** (array (string)) - **filters** (object) - **sort** (object) - **navigation** (object) - **page** (integer (int32)) - **limit** (integer (int32)) **Content-Type:** application/*+json - **fields** (array (string)) - **filters** (object) - **sort** (object) - **navigation** (object) - **page** (integer (int32)) - **limit** (integer (int32)) ### Responses #### 200 - **Success**
This endpoint allows you to retrieve a list of insights data based on the provided parameters.
You can specify various filters, sorting criteria, and pagination details to customize the data retrieval.
Optional fields include `fields`, `filters`, `sort`, and `navigation`.
The response will include the current page number, number of items per page, total number of items, and an array of results.
#### 400 - **Bad Request**
Basic filters are only allowed, please remove any premium or essential filters.
Basic filters must not contain null values.
#### 500 - **Internal Server Error**
Application and Server error, please contact support.
### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/dsa/insights" \ -H "Content-Type: application/json" \ -d '{ "fields": [ "string" ], "filters": "value", "sort": "value", "navigation": "value" }' ``` ``` -------------------------------- ### POST /api/v1.0.0/extensions/{extensionId}:resume Source: https://apieuw.productmarketingcloud.com/swagger/v1/swagger.json Requires View and ManageExtensions permission. ```markdown ### Parameters - **extensionId** (string, path, required): The unique ExtensionId. ### Responses #### 200 - Success **ExtensionStatusModel** - **isEnabled** (boolean) - **isPaused** (boolean) **ExtensionStatusModel** **ExtensionStatusModel** #### 404 - Not Found **ProblemDetails** - **type** (string) - **title** (string) - **status** (integer (int32)) - **detail** (string) - **instance** (string) **ProblemDetails** **ProblemDetails** #### 500 - Server Error Server Error ### Example Usage ```bash curl -X POST "https://api.example.com/api/v1.0.0/extensions/{extensionId}:resume" ``` ```