Jump to

• Request
• Response

Update one cost planning scenario

patch

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

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: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignmentSetId: integer (int64)
• AssignmentSetName: string
  Maximum Length: 34
• AttachmentEntityName: string
  Maximum Length: 255
• AttachmentsVA: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• Comments: string
  Maximum Length: 1000
• CostBookCode: string
  Maximum Length: 30
• CostBookDescription: string
  Title: Description

  Maximum Length: 240
• CostBookId: integer (int64)
  Default Value: -1
• CostOrgCode: string
  Maximum Length: 150
• CostOrgId: integer (int64)
  Default Value: -1
• CostOrgName: string
  Maximum Length: 240
• EffectiveStartDate(required): string (date)
• OrganizationContext: string
  Maximum Length: 30
• PeriodName: string
  Maximum Length: 15
• ReasonCode: string
  Maximum Length: 30
• RollupGroupDescription: string
  Maximum Length: 240
• RollupGroupId: integer (int64)
  Default Value: -1
• RollupGroupName: string
  Maximum Length: 80
• RollupScope: string
  Maximum Length: 30

  Default Value: ALL_ITEMS
• RuleSetName: string
  Maximum Length: 80
• ScenarioId: integer (int64)
• ScenarioNumber(required): string
  Maximum Length: 30
• ScenarioTimeline: array Cost Scenario Events Timeline
  Title: Cost Scenario Events Timeline

  Details of the events logged for a cost scenario.
• ScenarioType: string
  Maximum Length: 30

  Default Value: STANDARD
• StateCode: string
  Maximum Length: 30

  Default Value: NEW
• StatusCode: string
  Maximum Length: 30

  Default Value: NEW
• SupplyChainRollupFlag: boolean
  Maximum Length: 1

  Default Value: false
• TransferCostRuleSetId: integer (int64)
• WorkDefinitionCriteria: array Work Definition Criteria
  Title: Work Definition Criteria

  Information on the configuration choices that are used to roll up costs of items in a cost scenario.

{
    "required":[
        "EffectiveStartDate",
        "ScenarioNumber"
    ],
    "type":"object",
    "properties":{
        "AssignmentSetId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssignmentSetName":{
            "maxLength":34,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentsVA":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-AttachmentsVA-item-patch-request"
            }
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "nullable":true
        },
        "CostBookCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostBookId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "CostOrgCode":{
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostOrgId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "CostOrgName":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "OrganizationContext":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodName":{
            "maxLength":15,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "RollupGroupDescription":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupGroupId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "RollupGroupName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupScope":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ALL_ITEMS",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScenarioType"
                ]
            }
        },
        "RuleSetName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScenarioId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ScenarioNumber":{
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "ScenarioTimeline":{
            "title":"Cost Scenario Events Timeline",
            "type":"array",
            "description":"Details of the events logged for a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-ScenarioTimeline-item-patch-request"
            }
        },
        "ScenarioType":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StateCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW"
        },
        "SupplyChainRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":false
        },
        "TransferCostRuleSetId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkDefinitionCriteria":{
            "title":"Work Definition Criteria",
            "type":"array",
            "description":"Information on the configuration choices that are used to roll up costs of items in a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object schema

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

Nested Schema : Cost Scenario Events Timeline

Type: array

Title: Cost Scenario Events Timeline

Details of the events logged for a cost scenario.

Show Source

• Array of: object costScenariosV2-ScenarioTimeline-item-patch-request

{
    "title":"Cost Scenario Events Timeline",
    "type":"array",
    "description":"Details of the events logged for a cost scenario.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-ScenarioTimeline-item-patch-request"
    }
}

Nested Schema : Work Definition Criteria

Type: array

Title: Work Definition Criteria

Information on the configuration choices that are used to roll up costs of items in a cost scenario.

Show Source

• Array of: object schema

{
    "title":"Work Definition Criteria",
    "type":"array",
    "description":"Information on the configuration choices that are used to roll up costs of items in a cost scenario.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : costScenariosV2-ScenarioTimeline-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested 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.
• 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":{
        "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"
                ]
            }
        },
        "ExplosionSequenceMeaningOne":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the first attribute selected in the explosion sequence.",
            "nullable":true
        },
        "ExplosionSequenceMeaningThree":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the third attribute selected in the explosion sequence.",
            "nullable":true
        },
        "ExplosionSequenceMeaningTwo":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the second attribute selected in the explosion sequence.",
            "nullable":true
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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-patch-request"
            }
        },
        "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
            }
        }
    }
}

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-patch-request

{
    "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-patch-request"
    }
}

Nested Schema : costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-patch-request

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
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
                ]
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "ResourceCode":{
            "type":"string",
            "description":"Code for the resource used to set the scope of a type of configured item cost scenario.",
            "nullable":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
            }
        },
        "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"
            }
        }
    }
}

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

Type: object

Show Source

• AssignmentSetId: integer (int64)
• AssignmentSetName: string
  Maximum Length: 34
• AttachmentEntityName: string
  Maximum Length: 255
• AttachmentsVA: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• Comments: string
  Maximum Length: 1000
• CostBookCode: string
  Maximum Length: 30
• CostBookDescription: string
  Title: Description

  Maximum Length: 240
• CostBookId: integer (int64)
  Default Value: -1
• CostOrgCode: string
  Maximum Length: 150
• CostOrgId: integer (int64)
  Default Value: -1
• CostOrgName: string
  Maximum Length: 240
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• DownstreamDataExistsFlag: boolean
  Read Only: true
• EffectiveStartDate: string (date)
• IsDeleteAllowedFlag: boolean
  Read Only: true
• IsEditAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1
• IsPublishEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1
• IsRollupEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1
• IsUnpublishEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationContext: string
  Maximum Length: 30
• OrgContextMeaning: string
  Read Only: true

  Maximum Length: 80
• PeriodicAverageFlag: boolean
  Read Only: true

  Maximum Length: 1
• PeriodName: string
  Maximum Length: 15
• PeriodStatus: string
  Read Only: true

  Maximum Length: 255
• PeriodStatusMeaning: string
  Read Only: true

  Maximum Length: 255
• PrimaryBookFlag: boolean
  Title: Primary Book

  Read Only: true

  Maximum Length: 1
• ReasonCode: string
  Maximum Length: 30
• ReasonMeaning: string
  Read Only: true

  Maximum Length: 80
• RollupGroupDescription: string
  Maximum Length: 240
• RollupGroupId: integer (int64)
  Default Value: -1
• RollupGroupName: string
  Maximum Length: 80
• RollupScope: string
  Maximum Length: 30

  Default Value: ALL_ITEMS
• RollupScopeMeaning: string
  Read Only: true

  Maximum Length: 80
• RuleSetName: string
  Maximum Length: 80
• ScenarioId: integer (int64)
• ScenarioNumber: string
  Maximum Length: 30
• ScenarioTimeline: array Cost Scenario Events Timeline
  Title: Cost Scenario Events Timeline

  Details of the events logged for a cost scenario.
• ScenarioType: string
  Maximum Length: 30

  Default Value: STANDARD
• ScenarioTypeMeaning: string
  Read Only: true

  Maximum Length: 255
• StateCode: string
  Maximum Length: 30

  Default Value: NEW
• StateMeaning: string
  Read Only: true

  Maximum Length: 80
• StatusCode: string
  Maximum Length: 30

  Default Value: NEW
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80
• SupplyChainRollupFlag: boolean
  Maximum Length: 1

  Default Value: false
• TransferCostRuleSetId: integer (int64)
• WorkDefinitionCriteria: array Work Definition Criteria
  Title: Work Definition Criteria

  Information on the configuration choices that are used to roll up costs of items in a cost scenario.

{
    "type":"object",
    "properties":{
        "AssignmentSetId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentSetName":{
            "maxLength":34,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentsVA":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-AttachmentsVA-item-response"
            }
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CostBookCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrgCode":{
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostOrgId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrgName":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DownstreamDataExistsFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "IsDeleteAllowedFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsEditAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsPublishEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsRollupEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsUnpublishEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgContextMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationContext":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "PeriodName":{
            "maxLength":15,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PeriodStatus":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodicAverageFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryBookFlag":{
            "title":"Primary Book",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupGroupDescription":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RollupGroupId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RollupGroupName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RollupScope":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ALL_ITEMS",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScenarioType"
                ]
            },
            "x-queryable":true
        },
        "RollupScopeMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleSetName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ScenarioTimeline":{
            "title":"Cost Scenario Events Timeline",
            "type":"array",
            "description":"Details of the events logged for a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-ScenarioTimeline-item-response"
            }
        },
        "ScenarioType":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScenarioTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StateMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW",
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyChainRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TransferCostRuleSetId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionCriteria":{
            "title":"Work Definition Criteria",
            "type":"array",
            "description":"Information on the configuration choices that are used to roll up costs of items in a cost scenario.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object costScenariosV2-AttachmentsVA-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-AttachmentsVA-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 : Cost Scenario Events Timeline

Type: array

Title: Cost Scenario Events Timeline

Details of the events logged for a cost scenario.

Show Source

• Array of: object costScenariosV2-ScenarioTimeline-item-response

{
    "title":"Cost Scenario Events Timeline",
    "type":"array",
    "description":"Details of the events logged for a cost scenario.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-ScenarioTimeline-item-response"
    }
}

Nested Schema : Work Definition Criteria

Type: array

Title: Work Definition Criteria

Information on the configuration choices that are used to roll up costs of items in a cost scenario.

Show Source

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

{
    "title":"Work Definition Criteria",
    "type":"array",
    "description":"Information on the configuration choices that are used to roll up costs of items in a cost scenario.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-WorkDefinitionCriteria-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : costScenariosV2-AttachmentsVA-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• 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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of 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
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID 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
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI 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":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "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"
            }
        }
    }
}

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

Type: object

Show Source

• CompletedCount: integer (int32)
  Read Only: true

  Indicates the current completed count of the scenario event.
• EndTime: string (date-time)
  Read Only: true

  End time of the scenario event.
• ErrorCount: number
  Read Only: true

  Indicates the number of errors for the specific message.
• FailedCount: integer (int32)
  Read Only: true

  Indicates the current failed count of the scenario event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumEventDate: string (date-time)
  Read Only: true

  Maximum of date and time when the event occurred.
• MinimumEventDate: string (date-time)
  Read Only: true

  Minimum of date and time when the event occurred.
• ProcessId: integer (int64)
  Read Only: true

  Indicates the process identifier for the scenario event.
• ScenarioEventDate: string (date-time)
  Read Only: true

  Date and time when the event occurred.
• ScenarioEventId: integer (int64)
  Read Only: true

  Indicates the surrogate identifier generated for scenario event.
• ScenarioEventNumber: string
  Read Only: true

  Maximum Length: 30

  User-defined event number for scenario events.
• ScenarioEventType: string
  Read Only: true

  Maximum Length: 30

  Indicates the type of scenario event. Valid values are CREATE, BUILD, ROLLUP, and PUBLISH.
• ScenarioId: integer
  Read Only: true

  Indicates the unique identifier for a cost planning scenario.
• ScenarioNumber: string
  Read Only: true

  Maximum Length: 30

  Indicates the definable name that identifies a cost planning scenario.
• StartTime: string (date-time)
  Read Only: true

  Start time of the scenario event.
• Status: string
  Read Only: true

  Maximum Length: 80

  Status of the cost scenario.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Indicates the status of the scenario event. Valid values are NOT_STARTED, PROCESSING, SUCCESS, WARNING, ERROR, and CANCELED.
• Submitter: string
  Read Only: true

  Maximum Length: 1000

  Indicates the user who submitted the process.
• TimeElapsed: integer
  Read Only: true

  Indicates the time elapsed for an event.
• TotalCount: integer (int32)
  Read Only: true

  Indicates the total count of the scenario event.
• WarningCount: number
  Read Only: true

  Indicates the number of warnings for the specific message.

{
    "type":"object",
    "properties":{
        "CompletedCount":{
            "type":"integer",
            "description":"Indicates the current completed count of the scenario event.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"End time of the scenario event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorCount":{
            "type":"number",
            "description":"Indicates the number of errors for the specific message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailedCount":{
            "type":"integer",
            "description":"Indicates the current failed count of the scenario event.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MaximumEventDate":{
            "type":"string",
            "description":"Maximum of date and time when the event occurred.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumEventDate":{
            "type":"string",
            "description":"Minimum of date and time when the event occurred.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Indicates the process identifier for the scenario event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioEventDate":{
            "type":"string",
            "description":"Date and time when the event occurred.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventId":{
            "type":"integer",
            "description":"Indicates the surrogate identifier generated for scenario event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioEventNumber":{
            "maxLength":30,
            "type":"string",
            "description":"User-defined event number for scenario events.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioEventType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of scenario event. Valid values are CREATE, BUILD, ROLLUP, and PUBLISH.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "description":"Indicates the unique identifier for a cost planning scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the definable name that identifies a cost planning scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Start time of the scenario event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the cost scenario.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the scenario event. Valid values are NOT_STARTED, PROCESSING, SUCCESS, WARNING, ERROR, and CANCELED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Submitter":{
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the user who submitted the process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeElapsed":{
            "type":"integer",
            "description":"Indicates the time elapsed for an event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalCount":{
            "type":"integer",
            "description":"Indicates the total count of the scenario event.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "WarningCount":{
            "type":"number",
            "description":"Indicates the number of warnings for the specific message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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":{
        "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
        },
        "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
        },
        "ExplosionSequenceMeaningOne":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the first attribute selected in the explosion sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "ExplosionSequenceMeaningThree":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the third attribute selected in the explosion sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "ExplosionSequenceMeaningTwo":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the second attribute selected in the explosion sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Contains the resource type.",
            "nullable":false,
            "readOnly":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

AttachmentsVA

Operation: /fscmRestApi/resources/11.13.18.05/costScenariosV2/{ScenarioId}/child/AttachmentsVA

Parameters:

• ScenarioId: $request.path.ScenarioId

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

ScenarioTimeline

Operation: /fscmRestApi/resources/11.13.18.05/costScenariosV2/{ScenarioId}/child/ScenarioTimeline

Parameters:

• ScenarioId: $request.path.ScenarioId

Details of the events logged for a cost scenario.

WorkDefinitionCriteria

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

Parameters:

• ScenarioId: $request.path.ScenarioId

Information on the configuration choices that are used to roll up costs of items in a cost scenario.

runScenarioProcessor

Operation: /fscmRestApi/resources/11.13.18.05/costScenariosV2/{ScenarioId}/action/runScenarioProcessor

Parameters:

• ScenarioId: $request.path.ScenarioId

Back to Top