Jump to

• Request
• Response
• Examples

Create a new item request

post

/fscmRestApi/resources/11.13.18.05/newItemRequests

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignedTo: string
  User assigned to the new item request object.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource gets the attachments of a new item request.
• ChangeTypeId(required): integer (int64)
  Value that uniquely identifies the type of the new item request.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the new item request.
• NeedByDate: string (date-time)
  Date by when the new item request is required.
• newItemRequestAffectedItems: array New Item Request Lines
  Title: New Item Request Lines

  The New Item Request Affected Items resource contains details of the items in the new item request.
• NewItemRequestName(required): string
  Title: Name

  Maximum Length: 240

  Name of the new item request.
• NewItemRequestNumber(required): string
  Title: Number

  Maximum Length: 50

  Number corresponding to the new item request.
• newItemRequestsDFF: array Flexfields for New Item Requests
  Title: Flexfields for New Item Requests

  The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.
• NewItemRequestType: string
  Maximum Length: 255

  Value that indicates the type identifier corresponding to the new item request.
• OrganizationCode(required): string
  Maximum Length: 255

  Abbreviation that identifies the organization of the new item request.
• OrganizationId(required): integer (int64)
  Value that uniquely identifies the organization of the new item request.
• Priority: string
  Maximum Length: 255

  Value that indicates the priority of the new item request object.
• PriorityCode: string
  Maximum Length: 30

  Abbreviation that identifies the priority of the new item request.
• Reason: string
  Maximum Length: 255

  Value that indicates the reason for requesting the new item request.
• ReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the reason for the new item request.
• RequestedBy: string
  User who requested the new item request.

{
    "required":[
        "ChangeTypeId",
        "NewItemRequestName",
        "NewItemRequestNumber",
        "OrganizationCode",
        "OrganizationId"
    ],
    "type":"object",
    "properties":{
        "ChangeTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of the new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the new item request.",
            "nullable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource gets the attachments of a new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-attachments-item-post-request"
            }
        },
        "Priority":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the priority of the new item request object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "newItemRequestsDFF":{
            "title":"Flexfields for New Item Requests",
            "type":"array",
            "description":"The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestsDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "PriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the priority of the new item request.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason for the new item request.",
            "nullable":true
        },
        "Reason":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the reason for requesting the new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NewItemRequestNumber":{
            "title":"Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number corresponding to the new item request.",
            "nullable":false
        },
        "AssignedTo":{
            "type":"string",
            "description":"User assigned to the new item request object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "newItemRequestAffectedItems":{
            "title":"New Item Request Lines",
            "type":"array",
            "description":"The New Item Request Affected Items resource contains details of the items in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-item-post-request"
            }
        },
        "NeedByDate":{
            "type":"string",
            "description":"Date by when the new item request is required.",
            "format":"date-time",
            "nullable":true
        },
        "NewItemRequestType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the type identifier corresponding to the new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization of the new item request.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NewItemRequestName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the new item request.",
            "nullable":false
        },
        "RequestedBy":{
            "type":"string",
            "description":"User who requested the new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource gets the attachments of a new item request.

Show Source

• Array of: object newItemRequests-attachments-item-post-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource gets the attachments of a new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-attachments-item-post-request"
    }
}

Nested Schema : New Item Request Lines

Type: array

Title: New Item Request Lines

The New Item Request Affected Items resource contains details of the items in the new item request.

Show Source

• Array of: object newItemRequests-newItemRequestAffectedItems-item-post-request

{
    "title":"New Item Request Lines",
    "type":"array",
    "description":"The New Item Request Affected Items resource contains details of the items in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-item-post-request"
    }
}

Nested Schema : Flexfields for New Item Requests

Type: array

Title: Flexfields for New Item Requests

The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.

Show Source

• Array of: object newItemRequests-newItemRequestsDFF-item-post-request

{
    "title":"Flexfields for New Item Requests",
    "type":"array",
    "description":"The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : newItemRequests-attachments-item-post-request

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

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

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

  Description of the attached file.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Repository folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

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

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

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

  Date when the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  URL (Uniform Resource Locator) of the attached file.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

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

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

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

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

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies 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":"Repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 : newItemRequests-newItemRequestAffectedItems-item-post-request

Type: object

Show Source

• EffectiveDate: string (date-time)
  Date when the item becomes effective.
• ItemId(required): integer
  Value that uniquely identifies the item.
• ItemRevision: string
  Maximum Length: 255

  Revision of the item.
• ItemRevisionId(required): integer
  Value that uniquely identifies the item revision.
• newItemRequestLineTranslations: array New Item Request Line Translations
  Title: New Item Request Line Translations

  The New Item Request Line Translations resource contains details of the translations of a item in the new item request.

{
    "required":[
        "ItemId",
        "ItemRevisionId"
    ],
    "type":"object",
    "properties":{
        "ItemRevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item revision.",
            "nullable":false
        },
        "ItemRevision":{
            "maxLength":"255",
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "newItemRequestLineTranslations":{
            "title":"New Item Request Line Translations",
            "type":"array",
            "description":"The New Item Request Line Translations resource contains details of the translations of a item in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-post-request"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":false
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date when the item becomes effective.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : New Item Request Line Translations

Type: array

Title: New Item Request Line Translations

The New Item Request Line Translations resource contains details of the translations of a item in the new item request.

Show Source

• Array of: object newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-post-request

{
    "title":"New Item Request Line Translations",
    "type":"array",
    "description":"The New Item Request Line Translations resource contains details of the translations of a item in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-post-request"
    }
}

Nested Schema : newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-post-request

Type: object

Show Source

• CancelComments: string
  Maximum Length: 240

  Comments for the cancel action.
• Description: string
  Maximum Length: 2000

  Description of the translation.
• Language: string
  Maximum Length: 4

  Language of the translation.
• Name: string
  Maximum Length: 240

  Name of the translation.
• ObjectVersionNumber: integer (int32)
  Version number of the translation.
• SourceLang: string
  Maximum Length: 4

  Source language of the translation.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the translation.",
            "nullable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Language of the translation.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the translation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Source language of the translation.",
            "nullable":false
        },
        "CancelComments":{
            "maxLength":"240",
            "type":"string",
            "description":"Comments for the cancel action.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Name":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the translation.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        }
    }
}

Nested Schema : newItemRequests-newItemRequestsDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for new item requests.
• BaseChangeMgmtTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the base change management type of the new item request.
• ChangeId: integer (int64)
  Value that uniquely identifies the new item request.

{
    "type":"object",
    "properties":{
        "ChangeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "BaseChangeMgmtTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the base change management type of the new item request.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for new item requests.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DerivedFromParameter":"PRODUCT_CONTEXT",
                "FND_ACFF_ValueSetInfo":"ORA_EGO_CHANGE_TYPES_VS#TABLE",
                "controlType":"choice",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_DV":"PRODUCT_CONTEXT",
                "FND_ACFF_DVT":"P",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

Type: object

Show Source

• ApprovalDate: string (date-time)
  Read Only: true

  Date when the new item request object was approved.
• ApprovalRequestDate: string (date-time)
  Read Only: true

  Date when new item request approval was received.
• ApprovalStatusType: integer (int64)
  Read Only: true

  Value that identifies the approval status of the new item request.
• ApprovalStatusValue: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the approval status of the new item request.
• AssignedTo: string
  User assigned to the new item request object.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource gets the attachments of a new item request.
• CancellationDate: string (date-time)
  Read Only: true

  Date when the new item request was canceled.
• ChangeTypeId: integer (int64)
  Value that uniquely identifies the type of the new item request.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the new item request object.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the new item request.
• Description: string
  Title: Description

  Maximum Length: 2000

  Description of the new item request.
• ImplementationDate: string (date-time)
  Read Only: true

  Date when the new item request was implemented.
• InitiationDate: string (date-time)
  Read Only: true

  Date when the new item request was initiated.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the new item request.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the new item request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NeedByDate: string (date-time)
  Date by when the new item request is required.
• newItemRequestAffectedItems: array New Item Request Lines
  Title: New Item Request Lines

  The New Item Request Affected Items resource contains details of the items in the new item request.
• NewItemRequestId: integer (int64)
  Read Only: true

  Value that uniquely identifies the new item request.
• NewItemRequestName: string
  Title: Name

  Maximum Length: 240

  Name of the new item request.
• NewItemRequestNumber: string
  Title: Number

  Maximum Length: 50

  Number corresponding to the new item request.
• newItemRequestsDFF: array Flexfields for New Item Requests
  Title: Flexfields for New Item Requests

  The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.
• NewItemRequestType: string
  Maximum Length: 255

  Value that indicates the type identifier corresponding to the new item request.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization of the new item request.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization of the new item request.
• Priority: string
  Maximum Length: 255

  Value that indicates the priority of the new item request object.
• PriorityCode: string
  Maximum Length: 30

  Abbreviation that identifies the priority of the new item request.
• Reason: string
  Maximum Length: 255

  Value that indicates the reason for requesting the new item request.
• ReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the reason for the new item request.
• RequestedBy: string
  User who requested the new item request.
• Status: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the status of the new item request.
• StatusCode: integer (int64)
  Read Only: true

  Default Value: 0

  Abbreviation that identifies the status of the new item request.
• StatusType: integer (int64)
  Read Only: true

  Default Value: 0

  Value that indicates the type of status of the new item request.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource gets the attachments of a new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-attachments-item-response"
            }
        },
        "newItemRequestsDFF":{
            "title":"Flexfields for New Item Requests",
            "type":"array",
            "description":"The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "PriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the priority of the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the new item request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Reason":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the reason for requesting the new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InitiationDate":{
            "type":"string",
            "description":"Date when the new item request was initiated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewItemRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new item request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NewItemRequestType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the type identifier corresponding to the new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ImplementationDate":{
            "type":"string",
            "description":"Date when the new item request was implemented.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalStatusType":{
            "type":"integer",
            "description":"Value that identifies the approval status of the new item request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization of the new item request.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the new item request.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the status of the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of the new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CancellationDate":{
            "type":"string",
            "description":"Date when the new item request was canceled.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the new item request object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the priority of the new item request object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ApprovalStatusValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the approval status of the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason for the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalDate":{
            "type":"string",
            "description":"Date when the new item request object was approved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NewItemRequestNumber":{
            "title":"Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number corresponding to the new item request.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedTo":{
            "type":"string",
            "description":"User assigned to the new item request object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "newItemRequestAffectedItems":{
            "title":"New Item Request Lines",
            "type":"array",
            "description":"The New Item Request Affected Items resource contains details of the items in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-item-response"
            }
        },
        "NeedByDate":{
            "type":"string",
            "description":"Date by when the new item request is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatusType":{
            "type":"integer",
            "description":"Value that indicates the type of status of the new item request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApprovalRequestDate":{
            "type":"string",
            "description":"Date when new item request approval was received.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedBy":{
            "type":"string",
            "description":"User who requested the new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource gets the attachments of a new item request.

Show Source

• Array of: object newItemRequests-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource gets the attachments of a new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : New Item Request Lines

Type: array

Title: New Item Request Lines

The New Item Request Affected Items resource contains details of the items in the new item request.

Show Source

• Array of: object newItemRequests-newItemRequestAffectedItems-item-response

{
    "title":"New Item Request Lines",
    "type":"array",
    "description":"The New Item Request Affected Items resource contains details of the items in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-item-response"
    }
}

Nested Schema : Flexfields for New Item Requests

Type: array

Title: Flexfields for New Item Requests

The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.

Show Source

• Array of: object newItemRequests-newItemRequestsDFF-item-response

{
    "title":"Flexfields for New Item Requests",
    "type":"array",
    "description":"The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : newItemRequests-attachments-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

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

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

  Description of the attached file.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Repository folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

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

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

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

  Date when the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  URL (Uniform Resource Locator) of the attached 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

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

  Read Only: true

  Maximum Length: 255

  Login of the user who most recently updated the attached document.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the attachment for the change object.
• links: array Links
  Title: Links

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

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

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

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

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

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

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

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"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":"URI (Uniform Resource Identifier) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment for the change object.",
            "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":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "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":"Login of the user who most recently updated the attached document.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when adding the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment for the change object.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error 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":"Repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the attached document was most recently 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 : newItemRequests-newItemRequestAffectedItems-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the item to the new item request.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user added the item to the new item request.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description of the item.
• EffectiveDate: string (date-time)
  Date when the item becomes effective.
• ItemClass: string
  Read Only: true

  Maximum Length: 255

  Class of the item in the new item request.
• ItemClassCode: string
  Title: Item Class

  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the item class.
• ItemId: integer
  Value that uniquely identifies the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 1000

  Number that identifies the item in the new item request.
• ItemRevision: string
  Maximum Length: 255

  Revision of the item.
• ItemRevisionId: integer
  Value that uniquely identifies the item revision.
• ItemStatus: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the status of the item.
• ItemStatusCode: string
  Title: Item Status

  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the status of the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the item was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the item in the new item request.
• LineStatus: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the status of the item within the new item request.
• LineStatusCode: integer (int64)
  Read Only: true

  Abbreviation that identifies the status of the item within the new item request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewItemRequestId: integer
  Read Only: true

  Value that uniquely identifies the new item request.
• NewItemRequestLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item in the new item request.
• newItemRequestLineTranslations: array New Item Request Line Translations
  Title: New Item Request Line Translations

  The New Item Request Line Translations resource contains details of the translations of a item in the new item request.
• NewItemRequestNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the new item request.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the item in the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user added the item to the new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemClass":{
            "maxLength":"255",
            "type":"string",
            "description":"Class of the item in the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the status of the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemRevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item revision.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemClassCode":{
            "title":"Item Class",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the item class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who added the item to the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the item within the new item request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "newItemRequestLineTranslations":{
            "title":"New Item Request Line Translations",
            "type":"array",
            "description":"The New Item Request Line Translations resource contains details of the translations of a item in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":false,
            "x-queryable":true
        },
        "LineStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the status of the item within the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NewItemRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"1000",
            "type":"string",
            "description":"Number that identifies the item in the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemStatusCode":{
            "title":"Item Status",
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the status of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":"255",
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the new item request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the item was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date when the item becomes effective.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : New Item Request Line Translations

Type: array

Title: New Item Request Line Translations

The New Item Request Line Translations resource contains details of the translations of a item in the new item request.

Show Source

• Array of: object newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response

{
    "title":"New Item Request Line Translations",
    "type":"array",
    "description":"The New Item Request Line Translations resource contains details of the translations of a item in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response"
    }
}

Nested Schema : newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response

Type: object

Show Source

• CancelComments: string
  Maximum Length: 240

  Comments for the cancel action.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Creation date of the translation.
• Description: string
  Maximum Length: 2000

  Description of the translation.
• Language: string
  Maximum Length: 4

  Language of the translation.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the translation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the translation.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 240

  Name of the translation.
• ObjectVersionNumber: integer (int32)
  Version number of the translation.
• SourceLang: string
  Maximum Length: 4

  Source language of the translation.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the translation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the translation.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Language of the translation.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the translation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Source language of the translation.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CancelComments":{
            "maxLength":"240",
            "type":"string",
            "description":"Comments for the cancel action.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the translation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the translation.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : newItemRequests-newItemRequestsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for new item requests.
• BaseChangeMgmtTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the base change management type of the new item request.
• ChangeId: integer (int64)
  Value that uniquely identifies the new item request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ChangeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BaseChangeMgmtTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the base change management type of the new item request.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for new item requests.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DerivedFromParameter":"PRODUCT_CONTEXT",
                "FND_ACFF_ValueSetInfo":"ORA_EGO_CHANGE_TYPES_VS#TABLE",
                "controlType":"choice",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_DV":"PRODUCT_CONTEXT",
                "FND_ACFF_DVT":"P",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

attachments

Operation: /fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/attachments

Parameters:

• NewItemRequestId: $request.path.NewItemRequestId

The Attachments resource gets the attachments of a new item request.

newItemRequestAffectedItems

Operation: /fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/newItemRequestAffectedItems

Parameters:

• NewItemRequestId: $request.path.NewItemRequestId

The New Item Request Affected Items resource contains details of the items in the new item request.

newItemRequestsDFF

Operation: /fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/newItemRequestsDFF

Parameters:

• NewItemRequestId: $request.path.NewItemRequestId

The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.

Back to Top

Examples

This example describes how to create a new item request.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/newItemRequests"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"NewItemRequestType": "New Item Request",
	"OrganizationCode": "V1",
	"NewItemRequestName": "PLM26733_RestWS_NIR00061_ZCH",
	"NewItemRequestNumber": "PLM26733_RestWS_NIR00061_ZCH"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"ApprovalDate": null,
	"ApprovalRequestDate": null,
	"ApprovalStatusType": 1,
	"CancellationDate": null,
	"ChangeTypeId": 100000011980001,
	"CreatedBy": "PIMQA",
	"CreationDate": "2018-12-06T22:19:45-08:00",
	"Description": null,
	"ImplementationDate": null,
	"InitiationDate": "2018-12-06T00:00:00-08:00",
	"LastUpdateDate": "2018-12-06T22:20:04.114-08:00",
	"LastUpdatedBy": "PIMQA",
	"NeedByDate": null,
	"OrganizationId": 204,
	"ReasonCode": null,
	"StatusCode": 0,
	"StatusType": 0,
	"Status": "Draft",
	"PriorityCode": "HIGH",
	"Reason": null,
	"Priority": null,
	"NewItemRequestId": 300100151858534,
	"NewItemRequestType": "New Item Request",
	"NewItemRequestName": "PLM26733_RestWS_NIR00061_ZCH",
	"NewItemRequestNumber": "PLM26733_RestWS_NIR00061_ZCH",
	"ApprovalStatusValue": null,
	"OrganizationCode": "V1",
	"AssignedTo": "PIMQA",
	"RequestedBy": "PIMQA",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534",
		"name": "newItemRequests",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534",
		"name": "newItemRequests",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/PrioritiesLookupPVO1",
		"name": "PrioritiesLookupPVO1",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/ApprovalStatusTypesLookupPVO",
		"name": "ApprovalStatusTypesLookupPVO",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/UserPVO1",
		"name": "UserPVO1",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/ReasonsLookupPVO1",
		"name": "ReasonsLookupPVO1",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/UserPVO2",
		"name": "UserPVO2",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/LOVForOrganization",
		"name": "LOVForOrganization",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/ChangeOrderTypeVO1",
		"name": "ChangeOrderTypeVO1",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/child/newItemRequestAffectedItems",
		"name": "newItemRequestAffectedItems",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/child/newItemRequestsDFF",
		"name": "newItemRequestsDFF",
		"kind": "collection"
	},
	]
}

Back to Top