Production APIs
Artkit with Update Restriction information
| Report name | Product structure with Update Restriction information |
| Report identifier | 112584 |
| HTTP method | GET |
| URI | https://api.rambase.net/system/reports/112584/result-set?updateRestriction={updateRestriction} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 5878, version 10 |
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.
| updateRestriction String, optional |
Select which Update Restrictions to show
Default: ALL |
| $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.
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| CreatedBy Integer | Employee identifier. Available macros: currentUser() |
| EffectiveDate Date | Effective date this product structure will be valid frmo. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| IsBaseStructure Boolean | If true the structure version is a base structure for product. |
| ManufacturingAreaId Integer | Manufacturing area identifier. |
| ProductDescription String | Description of the product. |
| ProductId Integer | Product identifier. |
| ProductName String | Name of the product. |
| ProductStatus Integer | Status of the product. |
| ProductStructureVersionId Integer | Product structure identifier. |
| 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. |
| VersionName String | Name of the product structure version. |
Read more about filters and sorting on how to use sortable parameters
| CreatedAt Datetime | Date and time of creation |
| CreatedBy Integer | Employee identifier |
| EffectiveDate Date | Effective date this product structure will be valid frmo |
| IsBaseStructure Boolean | If true the structure version is a base structure for product |
| ManufacturingAreaId Integer | Manufacturing area identifier |
| ProductDescription String | Description of the product |
| ProductId Integer | Product identifier |
| ProductName String | Name of the product |
| ProductStatus Integer | Status of the product |
| ProductStructureVersionId Integer | Product structure identifier |
| 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 |
| VersionName String | Name of the product structure version |
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>ProductStructure
Product structure reference
>ProductStructureId
Product structure identifier
>{Long}</ProductStructureId>Product
Product reference
>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>Description
Description of the product
>{String}</Description>ProductLink
Product reference
>{String}</ProductLink>IsBaseStructure
If true the structure version is a base structure for product
>{Boolean}</IsBaseStructure>Version
Version number of this product structure
>{Integer}</Version>Name
Name of the product structure version
>{String}</Name>Revision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</Revision>ManufacturingArea
Manufacturing area
>ManufacturingAreaId
Manufacturing area identifier
>{Integer}</ManufacturingAreaId>Name
Name of manufacturing area
>{String}</Name>ManufacturingAreaLink
Manufacturing area reference
>{String}</ManufacturingAreaLink>CreatedBy
Created by reference
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>Name
Last name of employee
>{String}</Name>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Validity
Validity reference
>EffectiveDate
Effective date this product structure will be valid frmo
>{Date}</EffectiveDate>UpdateRestriction
Update restriction for the structure
Possible domain values can be found here
>{String}</UpdateRestriction>TargetApplication
Application reference when inspecting a line in a report.
>{String}</TargetApplication>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>Status
Status of product structure
Possible domain values can be found here
": "{Integer}",ProductStructureVersionId
Product structure identifier
": "{Integer}",ProductStructure
Product structure reference
": {ProductStructureId
Product structure identifier
": "{Long}",Product
Product reference
": {ProductId
Product identifier
": "{Integer}",Status
Status of the product
Possible domain values can be found here
": "{Integer}",Name
Name of the product
": "{String}",Description
Description of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"IsBaseStructure
If true the structure version is a base structure for product
": "{Boolean}",Version
Version number of this product structure
": "{Integer}",Name
Name of the product structure version
": "{String}",Revision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",ManufacturingArea
Manufacturing area
": {ManufacturingAreaId
Manufacturing area identifier
": "{Integer}",Name
Name of manufacturing area
": "{String}",ManufacturingAreaLink
Manufacturing area reference
": "{String}"CreatedBy
Created by reference
": {EmployeeId
Employee identifier
": "{Integer}",Name
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"CreatedAt
Date and time of creation
": "{Datetime}",Validity
Validity reference
": {EffectiveDate
Effective date this product structure will be valid frmo
": "{Date}"UpdateRestriction
Update restriction for the structure
Possible domain values can be found here
": "{String}",TargetApplication
Application reference when inspecting a line in a report.
": "{String}"
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 104920 HTTP 400 | Log text is required |
| Error 104921 HTTP 400 | Invalid log category |
| Error 101281 HTTP 400 | Too many {0} parameters. Maximum is {1}. |
| Error 100175 HTTP 400 | To date must be equal to, or later than from date. |
| Error 105710 HTTP 400 | Invalid output type |