REST API for Oracle Supply Chain Management Cloud

Create one work definition criteria detail for a cost planning scenario

post

/fscmRestApi/resources/11.13.18.05/costScenariosV2/{ScenarioId}/child/WorkDefinitionCriteria

Request

Path Parameters

ScenarioId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

ExplosionBasis: string

Maximum Length: 30

Default Value: TOP_DOWN

Indicates the basis used for work definition explosion in a scenario.
ExplosionSequence: string

Title: Explosion Basis

Maximum Length: 30

Default Value: PCN

Indicates the priority order used during exploding a work definition in a cost planning scenario.
ExplosionSequenceMeaningOne: string

Maximum Length: 255

Meaning of the first attribute selected in the explosion sequence.
ExplosionSequenceMeaningThree: string

Maximum Length: 255

Meaning of the third attribute selected in the explosion sequence.
ExplosionSequenceMeaningTwo: string

Maximum Length: 255

Meaning of the second attribute selected in the explosion sequence.
ExplosionSequenceOne: string

Maximum Length: 255

Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.
ExplosionSequenceThree: string

Maximum Length: 255

Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.
ExplosionSequenceTwo: string

Maximum Length: 255

Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.
LastNDays: integer (int32)

Indicates the number of days range to identify the purchase orders and work orders eligible for configured item rollup.
RefreshWdFlag: boolean

Maximum Length: 1

Default Value: true

Indicates whether during the build and rollup process, the work definition snapshots should be refreshed from the manufacturing tables or should the last used work definition for the item and plant combination from a previous scenario be used.
ScenarioId: integer (int64)

Indicates the cost planning scenario through which the criterion is created. This is used for audit trial only.
SingleLevelRollupFlag: boolean

Maximum Length: 1

Default Value: false

Indicates that only the first level of the item structure for the selected items will be rolled up.
UnprocessedOrdersDate: string (date)

Indicates the date after which the unprocessed orders of configured items are to be considered for cost roll up. This will be the planned start date for work orders and approval date for purchase orders.
WdCriterionId: integer (int64)

Indicates the unique identifier of the criterion used for scenario work definition explosion.
WorkDefinitionCriteriaDetails: array Work Definition Criteria Details

Title: Work Definition Criteria Details

Item number, resource code, catalog name, and category name specified in a cost scenario.
WorkDefinitionNameId: integer (int64)

Title: Work Definition

Indicates the work definition name that would be used during the work definition explosion in a cost planning scenario.
WorkDefName(required): string

Indicates the work definition name identifier that would be used during the work definition explosion in a cost planning scenario, when the work definition name option is selected.

{
    "required":[
        "WorkDefName"
    ],
    "type":"object",
    "properties":{
        "ExplosionSequenceOne":{
            "maxLength":"255",
            "type":"string",
            "description":"Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WdCriterionId":{
            "type":"integer",
            "description":"Indicates the unique identifier of the criterion used for scenario work definition explosion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "LastNDays":{
            "type":"integer",
            "description":"Indicates the number of days range to identify the purchase orders and work orders eligible for configured item rollup.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "ExplosionSequenceThree":{
            "maxLength":"255",
            "type":"string",
            "description":"Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Indicates the cost planning scenario through which the criterion is created. This is used for audit trial only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "UnprocessedOrdersDate":{
            "type":"string",
            "description":"Indicates the date after which the unprocessed orders of configured items are to be considered for cost roll up. This will be the planned start date for work orders and approval date for purchase orders.",
            "format":"date",
            "nullable":true
        },
        "ExplosionSequenceTwo":{
            "maxLength":"255",
            "type":"string",
            "description":"Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExplosionSequenceMeaningTwo":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the second attribute selected in the explosion sequence.",
            "nullable":true
        },
        "WorkDefinitionCriteriaDetails":{
            "title":"Work Definition Criteria Details",
            "type":"array",
            "description":"Item number, resource code, catalog name, and category name specified in a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-post-request"
            }
        },
        "ExplosionSequenceMeaningOne":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the first attribute selected in the explosion sequence.",
            "nullable":true
        },
        "WorkDefName":{
            "type":"string",
            "description":"Indicates the work definition name identifier that would be used during the work definition explosion in a cost planning scenario, when the work definition name option is selected.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SingleLevelRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that only the first level of the item structure for the selected items will be rolled up.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExplosionSequenceMeaningThree":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the third attribute selected in the explosion sequence.",
            "nullable":true
        },
        "ExplosionBasis":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the basis used for work definition explosion in a scenario.",
            "nullable":false,
            "default":"TOP_DOWN",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExplosionSequence":{
            "title":"Explosion Basis",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the priority order used during exploding a work definition in a cost planning scenario.",
            "nullable":false,
            "default":"PCN",
            "x-hints":{
                "dependencies":[
                    "ExplosionSequenceOne",
                    "ExplosionSequenceTwo",
                    "ExplosionSequenceThree"
                ]
            }
        },
        "WorkDefinitionNameId":{
            "title":"Work Definition",
            "type":"integer",
            "description":"Indicates the work definition name that would be used during the work definition explosion in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RefreshWdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether during the build and rollup process, the work definition snapshots should be refreshed from the manufacturing tables or should the last used work definition for the item and plant combination from a previous scenario be used.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Work Definition Criteria Details

Type: array

Title: Work Definition Criteria Details

Item number, resource code, catalog name, and category name specified in a cost scenario.

Show Source

Array of: object schema

{
    "title":"Work Definition Criteria Details",
    "type":"array",
    "description":"Item number, resource code, catalog name, and category name specified in a cost scenario.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

CategoryId: integer (int64)

Title: Category Name

Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.
CategoryName: string

Maximum Length: 2400

Indicates the name of the item category used to set the scope of the cost planning scenario.
CategorySetId: integer (int64)

Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.
CategorySetName: string

Maximum Length: 30

Indicates the set to which the category is mapped.
InventoryItemId: integer (int64)

Title: Item

Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.
ItemNumber: string

Maximum Length: 255

Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.
ResourceCode: string

Code for the resource used to set the scope of a type of configured item cost scenario.
ResourceId: integer (int64)

Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.
ResourceName: string

Name of the resource used to set the scope of a type of configured item cost scenario.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category Name",
            "type":"integer",
            "description":"Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "ResourceCode":{
            "type":"string",
            "description":"Code for the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "ResourceName":{
            "type":"string",
            "description":"Name of the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "CategoryName":{
            "maxLength":"2400",
            "type":"string",
            "description":"Indicates the name of the item category used to set the scope of the cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategorySetName":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the set to which the category is mapped.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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.

Root Schema : costScenariosV2-WorkDefinitionCriteria-item-response

Type: object

Show Source

ExplosionBasis: string

Maximum Length: 30

Default Value: TOP_DOWN

Indicates the basis used for work definition explosion in a scenario.
ExplosionSequence: string

Title: Explosion Basis

Maximum Length: 30

Default Value: PCN

Indicates the priority order used during exploding a work definition in a cost planning scenario.
ExplosionSequenceMeaningOne: string

Maximum Length: 255

Meaning of the first attribute selected in the explosion sequence.
ExplosionSequenceMeaningThree: string

Maximum Length: 255

Meaning of the third attribute selected in the explosion sequence.
ExplosionSequenceMeaningTwo: string

Maximum Length: 255

Meaning of the second attribute selected in the explosion sequence.
ExplosionSequenceOne: string

Maximum Length: 255

Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.
ExplosionSequenceThree: string

Maximum Length: 255

Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.
ExplosionSequenceTwo: string

Maximum Length: 255

Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.
LastNDays: integer (int32)

Indicates the number of days range to identify the purchase orders and work orders eligible for configured item rollup.
links: array Links

Title: Links

The link relations associated with the resource instance.
RefreshWdFlag: boolean

Maximum Length: 1

Default Value: true

Indicates whether during the build and rollup process, the work definition snapshots should be refreshed from the manufacturing tables or should the last used work definition for the item and plant combination from a previous scenario be used.
ScenarioId: integer (int64)

Indicates the cost planning scenario through which the criterion is created. This is used for audit trial only.
SingleLevelRollupFlag: boolean

Maximum Length: 1

Default Value: false

Indicates that only the first level of the item structure for the selected items will be rolled up.
UnprocessedOrdersDate: string (date)

Indicates the date after which the unprocessed orders of configured items are to be considered for cost roll up. This will be the planned start date for work orders and approval date for purchase orders.
WdCriterionId: integer (int64)

Indicates the unique identifier of the criterion used for scenario work definition explosion.
WorkDefinitionCriteriaDetails: array Work Definition Criteria Details

Title: Work Definition Criteria Details

Item number, resource code, catalog name, and category name specified in a cost scenario.
WorkDefinitionNameId: integer (int64)

Title: Work Definition

Indicates the work definition name that would be used during the work definition explosion in a cost planning scenario.
WorkDefName: string

Indicates the work definition name identifier that would be used during the work definition explosion in a cost planning scenario, when the work definition name option is selected.

{
    "type":"object",
    "properties":{
        "ExplosionSequenceOne":{
            "maxLength":"255",
            "type":"string",
            "description":"Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WdCriterionId":{
            "type":"integer",
            "description":"Indicates the unique identifier of the criterion used for scenario work definition explosion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastNDays":{
            "type":"integer",
            "description":"Indicates the number of days range to identify the purchase orders and work orders eligible for configured item rollup.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ExplosionSequenceThree":{
            "maxLength":"255",
            "type":"string",
            "description":"Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Indicates the cost planning scenario through which the criterion is created. This is used for audit trial only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnprocessedOrdersDate":{
            "type":"string",
            "description":"Indicates the date after which the unprocessed orders of configured items are to be considered for cost roll up. This will be the planned start date for work orders and approval date for purchase orders.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExplosionSequenceTwo":{
            "maxLength":"255",
            "type":"string",
            "description":"Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExplosionSequenceMeaningTwo":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the second attribute selected in the explosion sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkDefinitionCriteriaDetails":{
            "title":"Work Definition Criteria Details",
            "type":"array",
            "description":"Item number, resource code, catalog name, and category name specified in a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-response"
            }
        },
        "ExplosionSequenceMeaningOne":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the first attribute selected in the explosion sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkDefName":{
            "type":"string",
            "description":"Indicates the work definition name identifier that would be used during the work definition explosion in a cost planning scenario, when the work definition name option is selected.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SingleLevelRollupFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that only the first level of the item structure for the selected items will be rolled up.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExplosionSequenceMeaningThree":{
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the third attribute selected in the explosion sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "ExplosionBasis":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the basis used for work definition explosion in a scenario.",
            "nullable":false,
            "default":"TOP_DOWN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExplosionSequence":{
            "title":"Explosion Basis",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the priority order used during exploding a work definition in a cost planning scenario.",
            "nullable":false,
            "default":"PCN",
            "x-hints":{
                "dependencies":[
                    "ExplosionSequenceOne",
                    "ExplosionSequenceTwo",
                    "ExplosionSequenceThree"
                ]
            },
            "x-queryable":true
        },
        "WorkDefinitionNameId":{
            "title":"Work Definition",
            "type":"integer",
            "description":"Indicates the work definition name that would be used during the work definition explosion in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RefreshWdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether during the build and rollup process, the work definition snapshots should be refreshed from the manufacturing tables or should the last used work definition for the item and plant combination from a previous scenario be used.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : Work Definition Criteria Details

Type: array

Title: Work Definition Criteria Details

Item number, resource code, catalog name, and category name specified in a cost scenario.

Show Source

Array of: object costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-response

{
    "title":"Work Definition Criteria Details",
    "type":"array",
    "description":"Item number, resource code, catalog name, and category name specified in a cost scenario.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-response"
    }
}

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 : costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-response

Type: object

Show Source

CategoryDescription: string

Read Only: true

Maximum Length: 240

Indicates the item category used to set the scope of the cost planning scenario.
CategoryId: integer (int64)

Title: Category Name

Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.
CategoryName: string

Maximum Length: 2400

Indicates the name of the item category used to set the scope of the cost planning scenario.
CategorySetDescription: string

Read Only: true

Maximum Length: 240

Indicates the catalog to which the category is assigned.
CategorySetId: integer (int64)

Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.
CategorySetName: string

Maximum Length: 30

Indicates the set to which the category is mapped.
InventoryItemId: integer (int64)

Title: Item

Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.
ItemDescription: string

Title: Item Description

Read Only: true

Maximum Length: 240

Indicates the description of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.
ItemNumber: string

Maximum Length: 255

Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.
links: array Links

Title: Links

The link relations associated with the resource instance.
ResourceCode: string

Code for the resource used to set the scope of a type of configured item cost scenario.
ResourceId: integer (int64)

Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.
ResourceName: string

Name of the resource used to set the scope of a type of configured item cost scenario.
ResourceType: string

Title: Type

Read Only: true

Maximum Length: 30

Contains the resource type.
WdCriterionDetailId: integer (int64)

Read Only: true

Indicates the unique identifier for criteria detail.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category Name",
            "type":"integer",
            "description":"Indicates the item category identifier used to identify the work definitions to be used for cost rollup for a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceCode":{
            "type":"string",
            "description":"Code for the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true,
            "x-queryable":true
        },
        "WdCriterionDetailId":{
            "type":"integer",
            "description":"Indicates the unique identifier for criteria detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategorySetDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the catalog to which the category is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ResourceName":{
            "type":"string",
            "description":"Name of the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Indicates the item identifier used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Contains the resource type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the description of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the identifier of the item used to identify the work definitions used for rolling up the cost in a cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":"2400",
            "type":"string",
            "description":"Indicates the name of the item category used to set the scope of the cost planning scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Indicates the item category used to set the scope of the cost planning scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategorySetName":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the set to which the category is mapped.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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

WorkDefinitionCriteriaDetails

Operation: /fscmRestApi/resources/11.13.18.05/costScenariosV2/{ScenarioId}/child/WorkDefinitionCriteria/{WdCriterionId}/child/WorkDefinitionCriteriaDetails

Parameters:

ScenarioId: $request.path.ScenarioId
WdCriterionId: $request.path.WdCriterionId

Item number, resource code, catalog name, and category name specified in a cost scenario.