Jump to

• Request
• Response

Create a multiple work definition criteria detail for a scenario

post

/fscmRestApi/resources/11.13.18.05/costScenarios/{costScenariosUniqID}/child/WorkDefinitionCriteriaDetails

Request

Path Parameters

• costScenariosUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Cost Scenarios resource and used to uniquely identify an instance of Cost Scenarios. The client should not generate the hash key value. Instead, the client should query on the Cost Scenarios collection resource in order to navigate to a specific instance of Cost Scenarios to get the hash key.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryId: integer (int64)
  Title: Category Name

  Uniquely identifies the item category for which the overhead rates are displayed.
• CategoryName: string
  Maximum Length: 2400

  Name of the item category where items would be rolled up within the scenario.
• CategorySetId: integer (int64)
  Unique identifier for item catalog.
• CategorySetName: string
  Maximum Length: 30

  Name of the item catalog.
• InventoryItemId: integer (int64)
  Title: Item

  Indicates the unique identifier of the selected item to be rolled up within the scenario.
• ItemNumber: string
  Maximum Length: 255

  Indicates the unique name of the selected item to be rolled up within the 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":"Uniquely identifies the item category for which the overhead rates are displayed.",
            "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 unique name of the selected item to be rolled up within the 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 unique identifier of the selected item to be rolled up within the scenario.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "CategoryName":{
            "maxLength":"2400",
            "type":"string",
            "description":"Name of the item category where items would be rolled up within the scenario.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategorySetName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Unique identifier for item catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• CategoryDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item category where items would be rolled up within the scenario.
• CategoryId: integer (int64)
  Title: Category Name

  Uniquely identifies the item category for which the overhead rates are displayed.
• CategoryName: string
  Maximum Length: 2400

  Name of the item category where items would be rolled up within the scenario.
• CategorySetDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item catalog.
• CategorySetId: integer (int64)
  Unique identifier for item catalog.
• CategorySetName: string
  Maximum Length: 30

  Name of the item catalog.
• InventoryItemId: integer (int64)
  Title: Item

  Indicates the unique identifier of the selected item to be rolled up within the scenario.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the selected item to be rolled up within the scenario.
• ItemNumber: string
  Maximum Length: 255

  Indicates the unique name of the selected item to be rolled up within the 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

  Surrogate key and unique identifier for criteria detail.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category Name",
            "type":"integer",
            "description":"Uniquely identifies the item category for which the overhead rates are displayed.",
            "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":"Surrogate key and 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":"Description of the item catalog.",
            "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 unique identifier of the selected item to be rolled up within the 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":"Description of the selected item to be rolled up within the scenario.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the unique name of the selected item to be rolled up within the 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":"Name of the item category where items would be rolled up within the 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":"Description of the item category where items would be rolled up within the scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategorySetName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Unique identifier for item catalog.",
            "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"
    }
}

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."
        }
    }
}

Back to Top