Jump to

• Request
• Response
• Examples

Get one line item

get

/fscmRestApi/resources/11.13.18.05/productConcepts/{ConceptId}/child/ConceptStructure/{ConceptStructureId}

Request

Path Parameters

• ConceptId(required): integer(int64)
  Value that uniquely identifies the concept.
• ConceptStructureId(required): integer(int64)
  Value that uniquely identifies the concept structure line item.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productConcepts-ConceptStructure-item-response

Type: object

Show Source

• ActualPowerConsumption: number
  Title: Actual Power

  Actual power consumption of this concept structure line item.
• ActualWeight: number
  Title: Actual Weight

  Actual weight of this concept structure line item.
• Alternate: string
  Title: Alternative

  Maximum Length: 3

  Default Value: n

  Flag to identify that the concept structure line item is an alternative.
• Attachments: array Attachments
  Title: Attachments

  The Attachments resource is used to view, create, and update attachments.
• Compliance: string
  Title: Compliance

  Maximum Length: 30

  Compliance level of this concept structure line item.
• ConceptStructureId: integer (int64)
  Read Only: true

  Value that uniquely identifies the concept structure line item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the concept structure line item.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the concept structure line item.
• Description: string
  Title: Description

  Description of the concept structure line item.
• FixedCost: number
  Title: Nonrecurring Cost

  Fixed cost of this concept structure line item.
• FlagAlternative1: string
  Maximum Length: 3

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 1.
• FlagAlternative10: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 10.
• FlagAlternative11: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 11.
• FlagAlternative12: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 12.
• FlagAlternative13: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 13.
• FlagAlternative14: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 14.
• FlagAlternative15: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 15.
• FlagAlternative2: string
  Maximum Length: 3

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 2.
• FlagAlternative3: string
  Maximum Length: 3

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 3.
• FlagAlternative4: string
  Maximum Length: 3

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 4.
• FlagAlternative5: string
  Maximum Length: 3

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 5.
• FlagAlternative6: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 6.
• FlagAlternative7: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 7.
• FlagAlternative8: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 8.
• FlagAlternative9: string
  Maximum Length: 1

  Default Value: n

  Flag to identify that the concept structure line item is assigned to solution alternative 9.
• Incidents: number
  Title: Incidents

  Number of incidents for this concept structure line item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the concept structure line item.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the concept structure line item.
• LeadTime: integer (int64)
  Title: Lead Time

  Lead time of this concept structure line item.
• Level: string
  Maximum Length: 255

  Level of the concept structure line item in the structure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialCost: number
  Title: Material Cost

  Actual material cost of this concept structure line item.
• Metrics: array Metrics
  Title: Metrics

  The Metrics resource is used to view the concept structure metrics across different solution alternatives of the product concept.
• Name: string
  Title: Name

  Maximum Length: 150

  Name of the concept structure line item.
• NonMaterialCost: number
  Title: Nonmaterial Cost

  Actual non material cost of this concept structure line item.
• NumberManufacturers: number
  Title: Manufacturers

  Number of manufacturers for this concept structure line item.
• ParentConceptStructureId: integer (int64)
  Value that uniquely identifies the parent of the concept structure line item.
• ParentLevel: string
  Maximum Length: 255

  Level of the parent line item in the structure.
• Quantity: number
  Title: Quantity

  Default Value: 1

  Quantity of the concept structure line item.
• Relationships: array Relationships
  Title: Relationships

  The Relationships resource manages the objects related to a concept. The objects reference a concept, an item, or other objects.
• Revision: number
  Title: Revision

  Revision of the object associated with the concept structure line item.
• Risk: string
  Title: Risk

  Maximum Length: 30

  Risk of this concept structure line item.
• Score: number
  Title: Score

  Score of this concept structure line item.
• TargetCost: number
  Title: Target Cost

  Target cost of this concept structure line item.
• TargetPowerConsumption: number
  Title: Target Power

  Target power consumption of this concept structure line item.
• TargetWeight: number
  Title: Target Weight

  Target weight of this concept structure line item.
• ToId: integer (int64)
  Read Only: true

  Value that uniquely identifies the component or sub-concept associated with this concept structure line item.
• ToItemId: string
  Maximum Length: 400

  Value that uniquely identifies the item associated with this concept structure line item.
• ToType: string
  Title: Type

  Maximum Length: 30

  Type of the object associated with this concept structure line item.
• Type: string
  Title: Type

  Type of the concept structure line item.
• Vendor: string
  Title: Supplier

  Maximum Length: 150

  Vendor of this concept structure line item.
• Volume: number
  Title: Volume

  Expected volume of this concept structure line item.

{
    "type":"object",
    "properties":{
        "ParentLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"Level of the parent line item in the structure.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ParentConceptStructureId"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the concept structure line item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberManufacturers":{
            "title":"Manufacturers",
            "type":"number",
            "description":"Number of manufacturers for this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Compliance":{
            "title":"Compliance",
            "maxLength":"30",
            "type":"string",
            "description":"Compliance level of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualWeight":{
            "title":"Actual Weight",
            "type":"number",
            "description":"Actual weight of this concept structure line item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"2"
            },
            "x-queryable":true
        },
        "TargetWeight":{
            "title":"Target Weight",
            "type":"number",
            "description":"Target weight of this concept structure line item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"2"
            },
            "x-queryable":true
        },
        "FlagAlternative9":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 9.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative8":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 8.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative7":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 7.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative6":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 6.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative5":{
            "maxLength":"3",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 5.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative4":{
            "maxLength":"3",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 4.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative3":{
            "maxLength":"3",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 3.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative2":{
            "maxLength":"3",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 2.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"Name of the concept structure line item.",
            "nullable":true,
            "x-queryable":false
        },
        "FlagAlternative1":{
            "maxLength":"3",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 1.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "Metrics":{
            "title":"Metrics",
            "type":"array",
            "description":"The Metrics resource is used to view the concept structure metrics across different solution alternatives of the product concept.",
            "items":{
                "$ref":"#/components/schemas/productConcepts-ConceptStructure-Metrics-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NonMaterialCost":{
            "title":"Nonmaterial Cost",
            "type":"number",
            "description":"Actual non material cost of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "MaterialCost":{
            "title":"Material Cost",
            "type":"number",
            "description":"Actual material cost of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualPowerConsumption":{
            "title":"Actual Power",
            "type":"number",
            "description":"Actual power consumption of this concept structure line item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"2"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the concept structure line item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the concept structure line item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConceptStructureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the concept structure line item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToId":{
            "type":"integer",
            "description":"Value that uniquely identifies the component or sub-concept associated with this concept structure line item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Revision":{
            "title":"Revision",
            "type":"number",
            "description":"Revision of the object associated with the concept structure line item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"255"
            }
        },
        "LeadTime":{
            "title":"Lead Time",
            "type":"integer",
            "description":"Lead time of this concept structure line item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Volume":{
            "title":"Volume",
            "type":"number",
            "description":"Expected volume of this concept structure line item.",
            "nullable":true,
            "x-hints":{
                "precision":"15",
                "scale":"2"
            },
            "x-queryable":true
        },
        "FixedCost":{
            "title":"Nonrecurring Cost",
            "type":"number",
            "description":"Fixed cost of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Level":{
            "maxLength":"255",
            "type":"string",
            "description":"Level of the concept structure line item in the structure.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ParentConceptStructureId",
                    "PosNo"
                ]
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the concept structure line item.",
            "nullable":true,
            "x-queryable":false
        },
        "Risk":{
            "title":"Risk",
            "maxLength":"30",
            "type":"string",
            "description":"Risk of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/productConcepts-ConceptStructure-Attachments-item-response"
            }
        },
        "TargetPowerConsumption":{
            "title":"Target Power",
            "type":"number",
            "description":"Target power consumption of this concept structure line item.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"2"
            },
            "x-queryable":true
        },
        "Relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The Relationships resource manages the objects related to a concept. The objects reference a concept, an item, or other objects.",
            "items":{
                "$ref":"#/components/schemas/productConcepts-ConceptStructure-Relationships-item-response"
            }
        },
        "ToItemId":{
            "maxLength":"400",
            "type":"string",
            "description":"Value that uniquely identifies the item associated with this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetCost":{
            "title":"Target Cost",
            "type":"number",
            "description":"Target cost of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentConceptStructureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent of the concept structure line item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Alternate":{
            "title":"Alternative",
            "maxLength":"3",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is an alternative.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the concept structure line item.",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"15",
                "scale":"10"
            },
            "x-queryable":true
        },
        "Incidents":{
            "title":"Incidents",
            "type":"number",
            "description":"Number of incidents for this concept structure line item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"80"
            }
        },
        "Vendor":{
            "title":"Supplier",
            "maxLength":"150",
            "type":"string",
            "description":"Vendor of this concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ToType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the object associated with this concept structure line item.",
            "nullable":false,
            "x-queryable":true
        },
        "FlagAlternative14":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 14.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative15":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 15.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "type":"string",
            "description":"Type of the concept structure line item.",
            "nullable":true,
            "x-queryable":false
        },
        "FlagAlternative10":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 10.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative11":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 11.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative12":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 12.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "FlagAlternative13":{
            "maxLength":"1",
            "type":"string",
            "description":"Flag to identify that the concept structure line item is assigned to solution alternative 13.",
            "nullable":true,
            "default":"n",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the concept structure line item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object productConcepts-ConceptStructure-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/productConcepts-ConceptStructure-Attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Metrics

Type: array

Title: Metrics

The Metrics resource is used to view the concept structure metrics across different solution alternatives of the product concept.

Show Source

• Array of: object productConcepts-ConceptStructure-Metrics-item-response

{
    "title":"Metrics",
    "type":"array",
    "description":"The Metrics resource is used to view the concept structure metrics across different solution alternatives of the product concept.",
    "items":{
        "$ref":"#/components/schemas/productConcepts-ConceptStructure-Metrics-item-response"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The Relationships resource manages the objects related to a concept. The objects reference a concept, an item, or other objects.

Show Source

• Array of: object productConcepts-ConceptStructure-Relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The Relationships resource manages the objects related to a concept. The objects reference a concept, an item, or other objects.",
    "items":{
        "$ref":"#/components/schemas/productConcepts-ConceptStructure-Relationships-item-response"
    }
}

Nested Schema : productConcepts-ConceptStructure-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then the application does not share the attachment. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attached document.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the document.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attached document.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the document from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment resides.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the document version from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents of the attached document expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attached document.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the file that is attached.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) that locates the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the user most recently updated the attached document.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the attached document.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Size of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of a topology manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attached document.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"Name of the file that is attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of a topology manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the document from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the document version from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the attached document.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attached document.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then the application does not share the attachment. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attached document.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attached document expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path where the attachment resides.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated the attached document.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : productConcepts-ConceptStructure-Metrics-item-response

Type: object

Show Source

• AlternativeIndex: integer (int64)
  Number that identifies the solution alternative this metric is assigned to.
• Compliance: string
  Maximum Length: 30

  Value that indicates whether the concept structure line item is compliant or not. A list of accepted values is defined in the lookup type ACD_PRODUCT_COMPLIANCE.
• Cost: number
  Title: Cost

  Cost of the concept structure line item.
• CostIncomplete: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the rolled up costs are based on incomplete data. If false, then the rolled up costs are based on complete data. This attribute does not have a default value.
• CostVariance: number
  Title: Variance

  Difference between the actual cost and the target cost.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the concept metrics.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the concept metrics.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the concept metrics.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the concept metrics.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricsId: integer (int64)
  Value that uniquely identifies the metric.
• MExAttributeNumber001: number
  Extension attribute 1 used for metrics rollup.
• MExAttributeNumber002: number
  Extension attribute 2 used for metrics rollup.
• MExAttributeNumber003: number
  Extension attribute 3 used for metrics rollup.
• MExAttributeNumber004: number
  Extension attribute 4 used for metrics rollup.
• MExAttributeNumber005: number
  Extension attribute 5 used for metrics rollup.
• MExAttributeNumber006: number
  Extension attribute 6 used for metrics rollup.
• MExAttributeNumber007: number
  Extension attribute 7 used for metrics rollup.
• MExAttributeNumber008: number
  Extension attribute 8 used for metrics rollup.
• MExAttributeNumber009: number
  Extension attribute 9 used for metrics rollup.
• MExAttributeNumber010: number
  Extension attribute 10 used for metrics rollup.
• MExAttributeNumber011: number
  Extension attribute 11 used for metrics rollup.
• MExAttributeNumber012: number
  Extension attribute 12 used for metrics rollup.
• MExAttributeNumber013: number
  Extension attribute 13 used for metrics rollup.
• MExAttributeNumber014: number
  Extension attribute 14 used for metrics rollup.
• MExAttributeNumber015: number
  Extension attribute 15 used for metrics rollup.
• MExAttributeNumber016: number
  Extension attribute 16 used for metrics rollup.
• MExAttributeNumber017: number
  Extension attribute 17 used for metrics rollup.
• MExAttributeNumber018: number
  Extension attribute 18 used for metrics rollup.
• MExAttributeNumber019: number
  Extension attribute 19 used for metrics rollup.
• MExAttributeNumber020: number
  Extension attribute 20 used for metrics rollup.
• MExAttributeNumber021: number
  Extension attribute 21 used for metrics rollup.
• MExAttributeNumber022: number
  Extension attribute 22 used for metrics rollup.
• MExAttributeNumber023: number
  Extension attribute 23 used for metrics rollup.
• MExAttributeNumber024: number
  Extension attribute 24 used for metrics rollup.
• MExAttributeNumber025: number
  Extension attribute 25 used for metrics rollup.
• MExAttributeNumber026: number
  Extension attribute 26 used for metrics rollup.
• MExAttributeNumber027: number
  Extension attribute 27 used for metrics rollup.
• MExAttributeNumber028: number
  Extension attribute 28 used for metrics rollup.
• MExAttributeNumber029: number
  Extension attribute 29 used for metrics rollup.
• MExAttributeNumber030: number
  Extension attribute 30 used for metrics rollup.
• MExAttributeNumber031: number
  Extension attribute 31 used for metrics rollup.
• MExAttributeNumber032: number
  Extension attribute 32 used for metrics rollup.
• MExAttributeNumber033: number
  Extension attribute 33 used for metrics rollup.
• MExAttributeNumber034: number
  Extension attribute 34 used for metrics rollup.
• MExAttributeNumber035: number
  Extension attribute 35 used for metrics rollup.
• MExAttributeNumber036: number
  Extension attribute 36 used for metrics rollup.
• MExAttributeNumber037: number
  Extension attribute 37 used for metrics rollup.
• MExAttributeNumber038: number
  Extension attribute 38 used for metrics rollup.
• MExAttributeNumber039: number
  Extension attribute 39 used for metrics rollup.
• MExAttributeNumber040: number
  Extension attribute 40 used for metrics rollup.
• MExAttributeNumber041: number
  Extension attribute 41 used for metrics rollup.
• MExAttributeNumber042: number
  Extension attribute 42 used for metrics rollup.
• MExAttributeNumber043: number
  Extension attribute 43 used for metrics rollup.
• MExAttributeNumber044: number
  Extension attribute 44 used for metrics rollup.
• MExAttributeNumber045: number
  Extension attribute 45 used for metrics rollup.
• MExAttributeNumber046: number
  Extension attribute 46 used for metrics rollup.
• MExAttributeNumber047: number
  Extension attribute 47 used for metrics rollup.
• MExAttributeNumber048: number
  Extension attribute 48 used for metrics rollup.
• MExAttributeNumber049: number
  Extension attribute 49 used for metrics rollup.
• MExAttributeNumber050: number
  Extension attribute 50 used for metrics rollup.
• MExAttributeNumber051: number
  Extension attribute 51 used for metrics rollup.
• PowerConsumption: number
  Title: Power

  Power consumption of the concept structure line item.
• PowerConsumptionVariance: number
  Title: Variance

  Difference between the actual power consumption and the target power consumption.
• PowerIncomplete: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the rolled up power consumption is based on incomplete data. If false, then the rolled up power consumption is based on complete data. This attribute does not have a default value.
• Score: number
  Title: Score

  Score of the concept structure line item.
• Weight: number
  Title: Weight

  Weight of the concept structure line item.
• WeightIncomplete: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the rolled up weight is based on incomplete data. If false, then the rolled up weight is based on complete data. This attribute does not have a default value.
• WeightVariance: number
  Title: Variance

  Difference between the actual weight and the target weight.

{
    "type":"object",
    "properties":{
        "WeightVariance":{
            "title":"Variance",
            "type":"number",
            "description":"Difference between the actual weight and the target weight.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the concept metrics.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MExAttributeNumber040":{
            "type":"number",
            "description":"Extension attribute 40 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "Compliance":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates whether the concept structure line item is compliant or not. A list of accepted values is defined in the lookup type ACD_PRODUCT_COMPLIANCE.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber001":{
            "type":"number",
            "description":"Extension attribute 1 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber045":{
            "type":"number",
            "description":"Extension attribute 45 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber002":{
            "type":"number",
            "description":"Extension attribute 2 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber046":{
            "type":"number",
            "description":"Extension attribute 46 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber003":{
            "type":"number",
            "description":"Extension attribute 3 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber047":{
            "type":"number",
            "description":"Extension attribute 47 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber004":{
            "type":"number",
            "description":"Extension attribute 4 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber048":{
            "type":"number",
            "description":"Extension attribute 48 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "PowerIncomplete":{
            "maxLength":"1",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the rolled up power consumption is based on incomplete data. If false, then the rolled up power consumption is based on complete data. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber041":{
            "type":"number",
            "description":"Extension attribute 41 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber042":{
            "type":"number",
            "description":"Extension attribute 42 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber043":{
            "type":"number",
            "description":"Extension attribute 43 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "PowerConsumption":{
            "title":"Power",
            "type":"number",
            "description":"Power consumption of the concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber044":{
            "type":"number",
            "description":"Extension attribute 44 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber009":{
            "type":"number",
            "description":"Extension attribute 9 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber005":{
            "type":"number",
            "description":"Extension attribute 5 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber049":{
            "type":"number",
            "description":"Extension attribute 49 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber006":{
            "type":"number",
            "description":"Extension attribute 6 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber007":{
            "type":"number",
            "description":"Extension attribute 7 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber008":{
            "type":"number",
            "description":"Extension attribute 8 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the concept metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MExAttributeNumber050":{
            "type":"number",
            "description":"Extension attribute 50 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the concept metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MExAttributeNumber051":{
            "type":"number",
            "description":"Extension attribute 51 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber012":{
            "type":"number",
            "description":"Extension attribute 12 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber013":{
            "type":"number",
            "description":"Extension attribute 13 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "WeightIncomplete":{
            "maxLength":"1",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the rolled up weight is based on incomplete data. If false, then the rolled up weight is based on complete data. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber014":{
            "type":"number",
            "description":"Extension attribute 14 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber015":{
            "type":"number",
            "description":"Extension attribute 15 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "Weight":{
            "title":"Weight",
            "type":"number",
            "description":"Weight of the concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber010":{
            "type":"number",
            "description":"Extension attribute 10 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber011":{
            "type":"number",
            "description":"Extension attribute 11 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"number",
            "description":"Score of the concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber016":{
            "type":"number",
            "description":"Extension attribute 16 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber017":{
            "type":"number",
            "description":"Extension attribute 17 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber018":{
            "type":"number",
            "description":"Extension attribute 18 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber019":{
            "type":"number",
            "description":"Extension attribute 19 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "CostIncomplete":{
            "maxLength":"1",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the rolled up costs are based on incomplete data. If false, then the rolled up costs are based on complete data. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber023":{
            "type":"number",
            "description":"Extension attribute 23 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber024":{
            "type":"number",
            "description":"Extension attribute 24 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber025":{
            "type":"number",
            "description":"Extension attribute 25 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "AlternativeIndex":{
            "type":"integer",
            "description":"Number that identifies the solution alternative this metric is assigned to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MExAttributeNumber026":{
            "type":"number",
            "description":"Extension attribute 26 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "Cost":{
            "title":"Cost",
            "type":"number",
            "description":"Cost of the concept structure line item.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber020":{
            "type":"number",
            "description":"Extension attribute 20 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber021":{
            "type":"number",
            "description":"Extension attribute 21 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber022":{
            "type":"number",
            "description":"Extension attribute 22 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber027":{
            "type":"number",
            "description":"Extension attribute 27 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber028":{
            "type":"number",
            "description":"Extension attribute 28 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber029":{
            "type":"number",
            "description":"Extension attribute 29 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "PowerConsumptionVariance":{
            "title":"Variance",
            "type":"number",
            "description":"Difference between the actual power consumption and the target power consumption.",
            "nullable":true,
            "x-queryable":true
        },
        "MExAttributeNumber034":{
            "type":"number",
            "description":"Extension attribute 34 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber035":{
            "type":"number",
            "description":"Extension attribute 35 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber036":{
            "type":"number",
            "description":"Extension attribute 36 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber037":{
            "type":"number",
            "description":"Extension attribute 37 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber030":{
            "type":"number",
            "description":"Extension attribute 30 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber031":{
            "type":"number",
            "description":"Extension attribute 31 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber032":{
            "type":"number",
            "description":"Extension attribute 32 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber033":{
            "type":"number",
            "description":"Extension attribute 33 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber038":{
            "type":"number",
            "description":"Extension attribute 38 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "MExAttributeNumber039":{
            "type":"number",
            "description":"Extension attribute 39 used for metrics rollup.",
            "nullable":true,
            "x-hints":{
                "ROLLUP_ENABLE":"YES"
            },
            "x-queryable":true
        },
        "CostVariance":{
            "title":"Variance",
            "type":"number",
            "description":"Difference between the actual cost and the target cost.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the concept metrics.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productConcepts-ConceptStructure-Relationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the relationship.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the relationship.
• Description: string
  Description of the related object.
• DestObjId: integer (int64)
  Value that uniquely identifies the destination object.
• DestObjType: string
  Maximum Length: 30

  Type of the destination object.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the relationship.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the relationship.
• LatestFlag: boolean
  Contains one of the following values: true or false. If true, then the related object is the latest. If false, then the related object is not the latest. This attribute does not have a default value.
• LatestFlagName: string
  Read Only: true

  Name of the latest flag.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the related object.
• RelationshipId: integer (int64)
  Read Only: true

  Value that uniquely identifies the relationship.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Type of relationship.
• Revision: string
  Maximum Length: 255

  Value that indicates the version or revision of the referenced object.
• SrcObjId: integer (int64)
  Value that uniquely identifies the source object.
• SrcObjType: string
  Maximum Length: 30

  Type of the source object.
• Status: string
  Status of the related object.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the related object is the latest. If false, then the related object is not the latest. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "DestObjType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of the destination object.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcObjType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of the source object.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Revision":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the version or revision of the referenced object.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DestObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LatestFlagName":{
            "type":"string",
            "description":"Name of the latest flag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/productConcepts/{ConceptId}/child/ConceptStructure/{ConceptStructureId}/child/Attachments

Parameters:

• ConceptId: $request.path.ConceptId
• ConceptStructureId: $request.path.ConceptStructureId

The Attachments resource is used to view, create, and update attachments.

Metrics

Operation: /fscmRestApi/resources/11.13.18.05/productConcepts/{ConceptId}/child/ConceptStructure/{ConceptStructureId}/child/Metrics

Parameters:

• ConceptId: $request.path.ConceptId
• ConceptStructureId: $request.path.ConceptStructureId

The Metrics resource is used to view the concept structure metrics across different solution alternatives of the product concept.

Relationships

Operation: /fscmRestApi/resources/11.13.18.05/productConcepts/{ConceptId}/child/ConceptStructure/{ConceptStructureId}/child/Relationships

Parameters:

• ConceptId: $request.path.ConceptId
• ConceptStructureId: $request.path.ConceptStructureId

The Relationships resource manages the objects related to a concept. The objects reference a concept, an item, or other objects.

Back to Top

Examples

This example describes how to get one line item.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/productConcepts/ConceptId/child/ConceptStructure/ConceptStructureId"

For example, the following command gets one line item of a concept structure:

curl -u username:password "https://servername/fscmRestApi/resources/version/productConcepts/300100545951379/child/ConceptStructure/300100545951422"

Example Response Body

The following shows an example of the response body in JSON format.

 "ToId": 300100545951421,
    "ToType": "COMPONENT",
    "ToItemId": null,
    "TargetCost": null,
    "MaterialCost": null,
    "NonMaterialCost": null,
    "FixedCost": null,
    "TargetWeight": null,
    "ActualWeight": null,
    "TargetPowerConsumption": null,
    "ActualPowerConsumption": null,
    "LeadTime": null,
    "Risk": null,
    "Compliance": null,
    "Vendor": null,
    "NumberManufacturers": null,
    "Incidents": null,
    "Score": null,
    "Volume": null,
    "CreationDate": "2021-08-15T06:33:43.029+00:00",
    "CreatedBy": "PLM_AUTO",
    "LastUpdateDate": "2021-08-15T06:35:29.417+00:00",
    "LastUpdatedBy": "PLM_AUTO",
    "Alternate": "n",
    "FlagAlternative1": "n",
    "FlagAlternative2": "n",
    "FlagAlternative3": "n",
    "FlagAlternative4": "n",
    "FlagAlternative5": "n",
    "FlagAlternative6": "n",
    "FlagAlternative7": "n",
    "FlagAlternative8": "n",
    "FlagAlternative9": "n",
    "FlagAlternative10": "n",
    "FlagAlternative11": "n",
    "FlagAlternative12": "n",
    "FlagAlternative13": "n",
    "FlagAlternative14": "n",
    "FlagAlternative15": "n",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/productConcepts/300100545951379/child/ConceptStructure/300100545951422",
            "name": "ConceptStructure",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/productConcepts/300100545951379/child/ConceptStructure/300100545951422",
            "name": "ConceptStructure",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/productConcepts/300100545951379",
            "name": "productConcepts",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/productConcepts/300100545951379/child/ConceptStructure/300100545951422/child/Attachments",
            "name": "Attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/productConcepts/300100545951379/child/ConceptStructure/300100545951422/child/Metrics",
            "name": "Metrics",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/productConcepts/300100545951379/child/ConceptStructure/300100545951422/child/Relationships",
            "name": "Relationships",
            "kind": "collection"
        }
    ]
}

Back to Top