GET product/structures/{productStructureId}

Details for provided product structure

Note: Log in to check if your API client have access to run this resource
Version: 3
Success HTTP Status Code: 200

Uri parameters

{productStructureId} Integer Product structure identifier

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 is required/mandatory.

Format:
1
1

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 Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page 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
<ProductStructure>
2
     <ProductStructureId
ProductStructureId

Product structure identifier

>
{Integer}</ProductStructureId>
3
     <Status
Status

Status of product structure

Possible domain values can be found here when logged in

>
{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
5
     <Name
Name

Name of the product structure version

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

Description of this product structure version

>
{String}</Description>
7
     <Version
Version

Version number of this product structure

>
{Integer}</Version>
8
     <Revision
Revision

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

>
{String}</Revision>
9
     <CreatedBy
CreatedBy

The employee who made this product structure version

>
10
          <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
11
          <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
12
     </CreatedBy>
13
     <Validity>
14
          <EffectiveDate
EffectiveDate

Effective date this product structure will be valid frmo

>
{Date}</EffectiveDate>
15
          <ExpireDate
ExpireDate

Expire date of this product structure

>
{Date}</ExpireDate>
16
     </Validity>
17
     <Product
Product

The product this structure is valid for

>
18
          <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
19
          <Status
Status

Status of the product

>
{Integer}</Status>
20
          <Name
Name

Name of the product

>
{String}</Name>
21
          <Type
Type

Type of product

Possible domain values can be found here when logged in

>
{String}</Type>
22
          <Description
Description

Description of the product

>
{String}</Description>
23
          <ProductLink
ProductLink

Product identifier

>
{String}</ProductLink>
24
     </Product>
25
     <Drawing
Drawing

Drawing of the product structure

>
26
          <Database
Database

Database of the object

>
{String}</Database>
27
          <FileVersionId
FileVersionId

File identifier

>
{Integer}</FileVersionId>
28
          <FileVersionLink
FileVersionLink

File reference

>
{String}</FileVersionLink>
29
     </Drawing>
30
     <ActivatedBy
ActivatedBy

Employee who activated the product structure

>
31
          <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
32
          <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
33
     </ActivatedBy>
34
</ProductStructure>
1
{
2
     "productStructure": {
3
          "productStructureId
ProductStructureId

Product structure identifier

":
"{Integer}",
4
          "status
Status

Status of product structure

Possible domain values can be found here when logged in

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

Date and time of creation

":
"{Datetime}",
6
          "name
Name

Name of the product structure version

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

Description of this product structure version

":
"{String}",
8
          "version
Version

Version number of this product structure

":
"{Integer}",
9
          "revision
Revision

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

":
"{String}",
10
          "createdBy
CreatedBy

The employee who made this product structure version

":
{
11
               "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
12
               "employeeLink
EmployeeLink

Employee reference

":
"{String}"
13
          },
14
          "validity": {
15
               "effectiveDate
EffectiveDate

Effective date this product structure will be valid frmo

":
"{Date}",
16
               "expireDate
ExpireDate

Expire date of this product structure

":
"{Date}"
17
          },
18
          "product
Product

The product this structure is valid for

":
{
19
               "productId
ProductId

Product identifier

":
"{Integer}",
20
               "status
Status

Status of the product

":
"{Integer}",
21
               "name
Name

Name of the product

":
"{String}",
22
               "type
Type

Type of product

Possible domain values can be found here when logged in

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

Description of the product

":
"{String}",
24
               "productLink
ProductLink

Product identifier

":
"{String}"
25
          },
26
          "drawing
Drawing

Drawing of the product structure

":
{
27
               "database
Database

Database of the object

":
"{String}",
28
               "fileVersionId
FileVersionId

File identifier

":
"{Integer}",
29
               "fileVersionLink
FileVersionLink

File reference

":
"{String}"
30
          },
31
          "activatedBy
ActivatedBy

Employee who activated the product structure

":
{
32
               "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
33
               "employeeLink
EmployeeLink

Employee reference

":
"{String}"
34
          }
35
     }
36
}

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 101746 HTTP 404 Product structure not found