API

Product APIs

POST product/shared-product-subscriptions/{sharedProductSubscriptionId}/product-type-mappings

Create a new shared product subscription product type mapping

HTTP method POST
URI https://api.rambase.net/product/shared-product-subscriptions/{sharedProductSubscriptionId}/product-type-mappings
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {sharedProductSubscriptionId} Shared product subscription identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 7195, version 1

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ProductTypeMapping>
2
     <ProductType>
3
          <Shared
Shared

Required/mandatory field

Shared product type, the one being copied from

Applicable domain values can be found here

>
{String}</Shared>
4
          <Local
Local

Required/mandatory field

Local product type, the product tyoe you want the product to have locally.

Applicable domain values can be found here

>
{String}</Local>
5
     </ProductType>
6
</ProductTypeMapping>
1
{
2
     "productTypeMapping": {
3
          "productType": {
4
               "shared
Shared

Required/mandatory field

Shared product type, the one being copied from

Applicable domain values can be found here

":
"{String}",
5
               "local
Local

Required/mandatory field

Local product type, the product tyoe you want the product to have locally.

Applicable domain values can be found here

":
"{String}"
6
          }
7
     }
8
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ProductTypeMapping>
2
     <ProductTypeMappingId
ProductTypeMappingId

Product type mapping identifier

>
{Integer}</ProductTypeMappingId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
4
     <UpdatedAt
UpdatedAt

Date and time of update

>
{Datetime}</UpdatedAt>
5
     <ProductType>
6
          <Shared
Shared

Shared product type, the one being copied from

Possible domain values can be found here

>
{String}</Shared>
7
          <Local
Local

Local product type, the product tyoe you want the product to have locally.

Possible domain values can be found here

>
{String}</Local>
8
     </ProductType>
9
</ProductTypeMapping>
1
{
2
     "productTypeMapping": {
3
          "productTypeMappingId
ProductTypeMappingId

Product type mapping identifier

":
"{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
5
          "updatedAt
UpdatedAt

Date and time of update

":
"{Datetime}",
6
          "productType": {
7
               "shared
Shared

Shared product type, the one being copied from

Possible domain values can be found here

":
"{String}",
8
               "local
Local

Local product type, the product tyoe you want the product to have locally.

Possible domain values can be found here

":
"{String}"
9
          }
10
     }
11
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 101551 HTTP 404 Object {0} not found
Error 110262 HTTP 400 Product type {0} can not be remapped
Error 110263 HTTP 400 Product type {0} can only be remapped to P (Part)
Error 110264 HTTP 400 Product type P can only be remapped to either one of {0}