Jump to

• Request
• Response

Get all

get

/fscmRestApi/resources/11.13.18.05/costScenariosV2

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey
    Finder Variables
    • ScenarioId; integer;
  • findByCostOrgCostBook
    Finder Variables
    • bindCostBookCode; string;
    • bindCostOrgName; string;
  • findByScenarioNumber
    Finder Variables
    • bindScenarioNumber; string;
  • findUnpublishedByCostOrgCostBook
    Finder Variables
    • bindCostBookCode; string;
    • bindCostOrgName; string;
  • getUnPublishedScenarioByCostOrgId
    Finder Variables
    • bind_CostOrgId; integer;
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentSetId; integer
  • AssignmentSetName; string
  • Comments; string
  • CostBookCode; string
  • CostBookDescription; string
  • CostBookId; integer
  • CostOrgCode; string
  • CostOrgId; integer
  • CostOrgName; string
  • CreatedBy; string
  • CreationDate; string
  • EffectiveStartDate; string
  • IsDeleteAllowedFlag; boolean
  • IsEditAllowedFlag; boolean
  • IsPublishEnabledFlag; boolean
  • IsRollupEnabledFlag; boolean
  • IsUnpublishEnabledFlag; boolean
  • LastUpdateDate; string
  • LastUpdatedBy; string
  • OrgContextMeaning; string
  • PeriodName; string
  • PeriodStatus; string
  • PeriodStatusMeaning; string
  • PeriodicAverageFlag; boolean
  • PrimaryBookFlag; boolean
  • ReasonCode; string
  • ReasonMeaning; string
  • RollupGroupDescription; string
  • RollupGroupId; integer
  • RollupGroupName; string
  • RollupScope; string
  • RollupScopeMeaning; string
  • RuleSetName; string
  • ScenarioId; integer
  • ScenarioNumber; string
  • ScenarioType; string
  • ScenarioTypeMeaning; string
  • StateCode; string
  • StateMeaning; string
  • StatusCode; string
  • StatusMeaning; string
  • SupplyChainRollupFlag; boolean
  • TransferCostRuleSetId; integer
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : costScenariosV2

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/costScenariosV2-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object costScenariosV2-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/costScenariosV2-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 : 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
• 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":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgContextMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW",
            "x-queryable":true
        },
        "AssignmentSetId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RollupGroupId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IsUnpublishEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationContext":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostOrgCode":{
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsEditAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ScenarioNumber":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodicAverageFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupScope":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"ALL_ITEMS",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScenarioType"
                ]
            },
            "x-queryable":true
        },
        "PeriodName":{
            "maxLength":15,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ReasonMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownstreamDataExistsFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CostOrgName":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ScenarioType":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IsDeleteAllowedFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrgId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryBookFlag":{
            "title":"Primary Book",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupGroupName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RollupGroupDescription":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransferCostRuleSetId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RollupScopeMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "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"
        },
        "RuleSetName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IsRollupEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IsPublishEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplyChainRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AssignmentSetName":{
            "maxLength":34,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "PeriodStatus":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object 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 : 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":{
        "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
        },
        "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"
            }
        },
        "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
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        }
    }
}

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-WorkDefinitionCriteria-item-response

Type: object

Show Source

• ExplosionBasis: string
  Maximum Length: 30

  Default Value: TOP_DOWN

  Indicates the basis used for work definition explosion in a scenario.
• ExplosionSequence: string
  Title: Explosion Basis

  Maximum Length: 30

  Default Value: PCN

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

  Meaning of the first attribute selected in the explosion sequence.
• ExplosionSequenceMeaningThree: string
  Maximum Length: 255

  Meaning of the third attribute selected in the explosion sequence.
• ExplosionSequenceMeaningTwo: string
  Maximum Length: 255

  Meaning of the second attribute selected in the explosion sequence.
• ExplosionSequenceOne: string
  Maximum Length: 255

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

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

  Explosion sequence for the rollup process. Values are C, highest costing priority, N, work definition name, and P, highest production priority.
• LastNDays: integer (int32)
  Indicates the number of days range to identify the purchase orders and work orders eligible for configured item rollup.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RefreshWdFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates whether during the build and rollup process, the work definition snapshots should be refreshed from the manufacturing tables or should the last used work definition for the item and plant combination from a previous scenario be used.
• ScenarioId: integer (int64)
  Indicates the cost planning scenario through which the criterion is created. This is used for audit trial only.
• SingleLevelRollupFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates that only the first level of the item structure for the selected items will be rolled up.
• UnprocessedOrdersDate: string (date)
  Indicates the date after which the unprocessed orders of configured items are to be considered for cost roll up. This will be the planned start date for work orders and approval date for purchase orders.
• WdCriterionId: integer (int64)
  Indicates the unique identifier of the criterion used for scenario work definition explosion.
• WorkDefinitionCriteriaDetails: array Work Definition Criteria Details
  Title: Work Definition Criteria Details

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

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Work Definition Criteria Details

Type: array

Title: Work Definition Criteria Details

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

Show Source

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

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

Nested Schema : costScenariosV2-WorkDefinitionCriteria-WorkDefinitionCriteriaDetails-item-response

Type: object

Show Source

• CategoryDescription: string
  Read Only: true

  Maximum Length: 240

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

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

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

  Maximum Length: 240

  Indicates the catalog to which the category is assigned.
• CategorySetId: integer (int64)
  Indicates the item cost category set to be used for identifying the work definitions used for work definition explosion in a cost planning scenario.
• CategorySetName: string
  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 240

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

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

  The link relations associated with the resource instance.
• ResourceCode: string
  Code for the resource used to set the scope of a type of configured item cost scenario.
• ResourceId: integer (int64)
  Indicates the resource to be used for identifying the work definitions used for rolling up cost in a cost planning scenario.
• ResourceName: string
  Name of the resource used to set the scope of a type of configured item cost scenario.
• ResourceType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Contains the resource type.
• WdCriterionDetailId: integer (int64)
  Read Only: true

  Indicates the unique identifier for criteria detail.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top