API

Product APIs

PUT product/structure-versions/{productStructureVersionId}

Update of product structure version

HTTP method PUT
URI https://api.rambase.net/product/structure-versions/{productStructureVersionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productStructureVersionId} Product structure identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3860, version 4

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
<ProductStructureVersion
ProductStructureVersion

This field is optional.

>
2
     <Name
Name

Name of the product structure version

This field is optional.

>{String}</Name>
3
     <Description
Description

Description of this product structure version

This field is optional.

>{String}</Description>
4
     <NoteToOperators
NoteToOperators

Information about product structure's version left for production operator

This field is optional.

>{String}</NoteToOperators>
5
     <Revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

This field is optional.

>{String}</Revision>
6
</ProductStructureVersion>
1
{
2
     "productStructureVersion
ProductStructureVersion

This field is optional.

": {
3
          "name
Name

Name of the product structure version

This field is optional.

": "{String}",
4
          "description
Description

Description of this product structure version

This field is optional.

": "{String}",
5
          "noteToOperators
NoteToOperators

Information about product structure's version left for production operator

This field is optional.

": "{String}",
6
          "revision
Revision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

This field is optional.

": "{String}"
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.

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. Fields colored in grey is expandable fields.

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

Format:
1
1

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 99946 HTTP 400 {0}: Missing mandatory arguments {1}
Error 101746 HTTP 404 Product structure not found. Id: {0}