Product APIs
All versions for all product structures
| HTTP method | GET |
| URI | https://api.rambase.net/product/structure-versions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 3852, version 9 |
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.
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.
| $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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| BaseVersion Integer | Base version of the product structure. Will initially be set as the version from the products active product structure. |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| Description String | Description of this product structure version. |
| HasEndOfLifeMaterial Boolean | Flag to indicate if the structure contains products which is at end of life. |
| IsBaseStructure Boolean | If true the structure version is a base structure for product. |
| IsDefaultBaseStructure Boolean | If true the structure version is a default base structure for product. |
| Name String | Name of the product structure version. |
| NeedsMaterialReplacementToRelease Boolean | A flag to indicate if product structure contains “dummy” product which needs to be replaced in the production work order structure before releasing the production. |
| OwnerType String | Type of product structure. |
| ProductId Docref-it | Product identifier. |
| ProductName String | Name of the product. |
| ProductStatus Integer | Status of the product. |
| ProductType String | Type of product. |
| Revision String | The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure. |
| Status Integer | Status of product structure. |
| Version Integer | Version number of this product structure. |
Read more about filters and sorting on how to use sortable parameters
| BaseVersion Integer | Base version of the product structure. Will initially be set as the version from the products active product structure. |
| CreatedAt Datetime | Date and time of creation |
| Description String | Description of this product structure version |
| HasEndOfLifeMaterial Boolean | Flag to indicate if the structure contains products which is at end of life |
| IsBaseStructure Boolean | If true the structure version is a base structure for product |
| IsDefaultBaseStructure Boolean | If true the structure version is a default base structure for product |
| Name String | Name of the product structure version |
| NeedsMaterialReplacementToRelease Boolean | A flag to indicate if product structure contains “dummy” product which needs to be replaced in the production work order structure before releasing the production |
| OwnerType String | Type of product structure |
| ProductId Docref-it | Product identifier |
| ProductName String | Name of the product |
| ProductStatus Integer | Status of the product |
| ProductType String | Type of product |
| Revision String | The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure. |
| Status Integer | Status of product structure |
| Version Integer | Version number of this product structure |
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.
ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Name
Name of the product structure version
>{String}</Name>Description
Description of this product structure version
>{String}</Description>Version
Version number of this product structure
>{Integer}</Version>NoteToOperators
Information about product structure's version left for production operator
>{String}</NoteToOperators>Revision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</Revision>ContainsMaterialPendingExpiration
Flag to indicate if the structure contains products which is at end of life
>{Boolean}</ContainsMaterialPendingExpiration>NeedsMaterialReplacementToRelease
A flag to indicate if product structure contains “dummy” product which needs to be replaced in the production work order structure before releasing the production
>{Boolean}</NeedsMaterialReplacementToRelease>IsBaseStructure
If true the structure version is a base structure for product
>{Boolean}</IsBaseStructure>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>Version
Base version of the product structure. Will initially be set as the version from the products active product structure.
>{Integer}</Version>ProductStructureVersionLink
Product structure reference
>{String}</ProductStructureVersionLink>CreatedBy
The employee who made this product structure version
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>EffectiveDate
Effective date this product structure will be valid frmo
>{Date}</EffectiveDate>ExpireDate
Expire date of this product structure
>{Date}</ExpireDate>Drawing
Drawing of the product structure
>Database
Database of the object
>{String}</Database>FileVersionId
File identifier
>{String}</FileVersionId>FileVersionLink
File reference
>{String}</FileVersionLink>ActivatedBy
Employee who activated the product structure
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>ProductStructureId
Product structure identifier
>{Long}</ProductStructureId>OwnerType
Type of product structure
Possible domain values can be found here
>{String}</OwnerType>Product
The product this structure is valid for
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product identifier
>{String}</ProductLink>Owner
The owner of the product structure
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ProductStructureVersionLink
Product structure identifier
>{String}</ProductStructureVersionLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>ProductStructureVersionId
Product structure identifier
": "{Integer}",Status
Status of product structure
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Name
Name of the product structure version
": "{String}",Description
Description of this product structure version
": "{String}",Version
Version number of this product structure
": "{Integer}",NoteToOperators
Information about product structure's version left for production operator
": "{String}",Revision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",ContainsMaterialPendingExpiration
Flag to indicate if the structure contains products which is at end of life
": "{Boolean}",NeedsMaterialReplacementToRelease
A flag to indicate if product structure contains “dummy” product which needs to be replaced in the production work order structure before releasing the production
": "{Boolean}",IsBaseStructure
If true the structure version is a base structure for product
": "{Boolean}",ProductStructureVersionId
Product structure identifier
": "{Integer}",Version
Base version of the product structure. Will initially be set as the version from the products active product structure.
": "{Integer}",ProductStructureVersionLink
Product structure reference
": "{String}"CreatedBy
The employee who made this product structure version
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"EffectiveDate
Effective date this product structure will be valid frmo
": "{Date}",ExpireDate
Expire date of this product structure
": "{Date}"Drawing
Drawing of the product structure
": {Database
Database of the object
": "{String}",FileVersionId
File identifier
": "{String}",FileVersionLink
File reference
": "{String}"ActivatedBy
Employee who activated the product structure
": {EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"ProductStructureId
Product structure identifier
": "{Long}",OwnerType
Type of product structure
Possible domain values can be found here
": "{String}",Product
The product this structure is valid for
": {ProductId
Product identifier
": "{Integer}",Status
Status of the product
Possible domain values can be found here
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",Description
Description of the product
": "{String}",ProductLink
Product identifier
": "{String}"Owner
The owner of the product structure
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"ProductStructureVersionLink
Product structure identifier
": "{String}",Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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: