Jump to

• Request
• Response
• Examples

Get one new item request

get

/fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : 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 New Item Request Line Attachments
  Title: New Item Request Line Attachments

  The New Item Request attachments of Affected Items resource contains details of the items attachments in the 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

  New item line of the new item request object.
• 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 newItemRequestsDFF
  Descriptive flexfield extensions for the new item request object.
• 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":{
        "ApprovalDate":{
            "type":"string",
            "description":"Date when the new item request object was approved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "ApprovalStatusValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the approval status of the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedTo":{
            "type":"string",
            "description":"User assigned to the new item request object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the new item request object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ImplementationDate":{
            "type":"string",
            "description":"Date when the new item request was implemented.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "type":"string",
            "description":"Date by when the new item request is required.",
            "format":"date-time",
            "nullable":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
        },
        "NewItemRequestName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the new item request.",
            "nullable":false,
            "x-queryable":true
        },
        "NewItemRequestNumber":{
            "title":"Number",
            "maxLength":50,
            "type":"string",
            "description":"Number corresponding to the new item request.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the priority of the new item request.",
            "nullable":true,
            "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
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the new item request.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedBy":{
            "type":"string",
            "description":"User who requested the new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "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
        },
        "attachments":{
            "title":"New Item Request Line Attachments",
            "type":"array",
            "description":"The New Item Request attachments of Affected Items resource contains details of the items attachments in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "newItemRequestAffectedItems":{
            "title":"New Item Request Lines",
            "type":"array",
            "description":"New item line of the new item request object.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-item-response"
            }
        },
        "newItemRequestsDFF":{
            "type":"array",
            "description":"Descriptive flexfield extensions for the new item request object.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestsDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : New Item Request Line Attachments

Type: array

Title: New Item Request Line Attachments

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

Show Source

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

{
    "title":"New Item Request Line Attachments",
    "type":"array",
    "description":"The New Item Request attachments of Affected Items resource contains details of the items attachments in the 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

New item line of the new item request object.

Show Source

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

{
    "title":"New Item Request Lines",
    "type":"array",
    "description":"New item line of the new item request object.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-item-response"
    }
}

Nested Schema : newItemRequestsDFF

Type: array

Descriptive flexfield extensions for the new item request object.

Show Source

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

{
    "type":"array",
    "description":"Descriptive flexfield extensions for the new item request object.",
    "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

  Asynchronous tracker ID value for the affected item attachment on a new item request.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Attached document ID for the affected item attachment on a new item request.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name for the affected item attachment on a new item request.
• ContentRepositoryFileCheckedOutBy: string
  Title: Checked Out By

  The user who has checked out the new item request affected items attachment from the repository.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Content repository file shared value for the affected item attachment on a new item request.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the affected item attachment on a new item request.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Name of the user who created the affected item attachment on a new item request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Creation date of the affected item attachment on a new item request.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Data type code for the affected item attachment on a new item request.
• DataTypeName: string
  Type of data for the affected item attachment on a new item request.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the affected item attachment on a new item request.
• DmDocumentId: string
  Maximum Length: 255

  DM (Document Management) document ID for the affected item attachment on a new item request.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  DM folder path for the affected item attachment on a new item request.
• DmVersionNumber: string
  Maximum Length: 255

  DM version number for the affected item attachment on a new item request.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Document preview value for the affected item attachment on a new item request.
• DownloadInfo: string
  Title: DownloadInfo

  Download info for the affected item attachment on a new item request.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code for the affected item attachment on a new item request.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message for the affected item attachment on a new item request.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration data for the affected item attachment on a new item request.
• FileContents: string (byte)
  Title: File Contents

  File contents of the affected item attachment on a new item request.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the affected item attachment on a new item request.
• FileUrl: string
  Title: File Url

  File URL of the affected item attachment on a new item request.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  File web image for the affected item attachment on a new item request.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Last update date of the affected item attachment on a new item request.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the affected item attachment on a new item request.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the user who last updated the affected item attachment on a new item request.
• links: array Links
  Title: Links

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

  Postprocessing action for the affected item attachment on a new item request.
• Title: string
  Title: Title

  Title of the affected item attachment on a new item request.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Uploaded file content type for the affected item attachment on a new item request.
• UploadedFileLength: integer
  Title: File Size

  Uploaded file length for the affected item attachment on a new item request.
• UploadedFileName: string
  Title: Uploaded File Name

  Uploaded file name for the affected item attachment on a new item request.
• UploadedText: string
  Title: Uploaded Text

  Uploaded text for the affected item attachment on a new item request.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI for the affected item attachment on a new item request.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL for the affected item attachment on a new item request.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Name for the affected item attachment on a new item request.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Asynchronous tracker ID value for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Attached document ID for the affected item attachment on a new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileCheckedOutBy":{
            "title":"Checked Out By",
            "type":"string",
            "description":"The user who has checked out the new item request affected items attachment from the repository.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "PAYLOADHINT":"Show"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Content repository file shared value for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the affected item attachment on a new item request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Name of the user who created the affected item attachment on a new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation date of the affected item attachment on a new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DataTypeName":{
            "type":"string",
            "description":"Type of data for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Data type code for the affected item attachment on a new item request.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"DM (Document Management) document ID for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"DM folder path for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"DM version number for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Document preview value for the affected item attachment on a new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Download info for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration data for the affected item attachment on a new item request.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the affected item attachment on a new item request.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"File web image for the affected item attachment on a new item request.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Last update date of the affected item attachment on a new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the affected item attachment on a new item request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the affected item attachment on a new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Postprocessing action for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Uploaded file content type for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Uploaded file length for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Uploaded file name for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Uploaded text for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Name for the affected item attachment on a new item request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : newItemRequests-newItemRequestAffectedItems-item-response

Type: object

Show Source

• attachments: array New Item Request Line Attachments
  Title: New Item Request Line Attachments

  The New Item Request attachments of Affected Items resource contains details of the items attachments in the new item request.
• 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

  An array of one or more instances which holds translatable values.
• NewItemRequestNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the new item request.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the item to 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
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date when the item becomes effective.",
            "format":"date-time",
            "nullable":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
        },
        "ItemClassCode":{
            "title":"Item Class",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the item class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":false,
            "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
        },
        "ItemRevision":{
            "maxLength":255,
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemRevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item revision.",
            "nullable":false,
            "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
        },
        "ItemStatusCode":{
            "title":"Item Status",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the status of the item.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "NewItemRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new item request.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "NewItemRequestNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"New Item Request Line Attachments",
            "type":"array",
            "description":"The New Item Request attachments of Affected Items resource contains details of the items attachments in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "newItemRequestLineTranslations":{
            "title":"New Item Request Line Translations",
            "type":"array",
            "description":"An array of one or more instances which holds translatable values.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response"
            }
        }
    }
}

Nested Schema : New Item Request Line Attachments

Type: array

Title: New Item Request Line Attachments

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

Show Source

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

{
    "title":"New Item Request Line Attachments",
    "type":"array",
    "description":"The New Item Request attachments of Affected Items resource contains details of the items attachments in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-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 Line Translations

Type: array

Title: New Item Request Line Translations

An array of one or more instances which holds translatable values.

Show Source

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

{
    "title":"New Item Request Line Translations",
    "type":"array",
    "description":"An array of one or more instances which holds translatable values.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response"
    }
}

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

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Asynchronous tracker ID value for the affected item attachment on a new item request.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Attached document ID for the affected item attachment on a new item request.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name for the affected item attachment on a new item request.
• ContentRepositoryFileCheckedOutBy: string
  Title: Checked Out By

  The user who has checked out the new item request affected items attachment from the repository.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Content repository file shared value for the affected item attachment on a new item request.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the affected item attachment on a new item request.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Name of the user who created the affected item attachment on a new item request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Creation date of the affected item attachment on a new item request.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Data type code for the affected item attachment on a new item request.
• DataTypeName: string
  Type of data for the affected item attachment on a new item request.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the affected item attachment on a new item request.
• DmDocumentId: string
  Maximum Length: 255

  DM (Document Management) document ID for the affected item attachment on a new item request.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  DM folder path for the affected item attachment on a new item request.
• DmVersionNumber: string
  Maximum Length: 255

  DM version number for the affected item attachment on a new item request.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Document preview value for the affected item attachment on a new item request.
• DownloadInfo: string
  Title: DownloadInfo

  Download info for the affected item attachment on a new item request.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code for the affected item attachment on a new item request.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message for the affected item attachment on a new item request.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration data for the affected item attachment on a new item request.
• FileContents: string (byte)
  Title: File Contents

  File contents of the affected item attachment on a new item request.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the affected item attachment on a new item request.
• FileUrl: string
  Title: File Url

  File URL of the affected item attachment on a new item request.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  File web image for the affected item attachment on a new item request.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Last update date of the affected item attachment on a new item request.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the affected item attachment on a new item request.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the user who last updated the affected item attachment on a new item request.
• links: array Links
  Title: Links

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

  Postprocessing action for the affected item attachment on a new item request.
• Title: string
  Title: Title

  Title of the affected item attachment on a new item request.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Uploaded file content type for the affected item attachment on a new item request.
• UploadedFileLength: integer
  Title: File Size

  Uploaded file length for the affected item attachment on a new item request.
• UploadedFileName: string
  Title: Uploaded File Name

  Uploaded file name for the affected item attachment on a new item request.
• UploadedText: string
  Title: Uploaded Text

  Uploaded text for the affected item attachment on a new item request.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI for the affected item attachment on a new item request.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL for the affected item attachment on a new item request.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Name for the affected item attachment on a new item request.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Asynchronous tracker ID value for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Attached document ID for the affected item attachment on a new item request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileCheckedOutBy":{
            "title":"Checked Out By",
            "type":"string",
            "description":"The user who has checked out the new item request affected items attachment from the repository.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "PAYLOADHINT":"Show"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Content repository file shared value for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the affected item attachment on a new item request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Name of the user who created the affected item attachment on a new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation date of the affected item attachment on a new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DataTypeName":{
            "type":"string",
            "description":"Type of data for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Data type code for the affected item attachment on a new item request.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"DM (Document Management) document ID for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"DM folder path for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"DM version number for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Document preview value for the affected item attachment on a new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Download info for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration data for the affected item attachment on a new item request.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the affected item attachment on a new item request.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"File web image for the affected item attachment on a new item request.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Last update date of the affected item attachment on a new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the affected item attachment on a new item request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the affected item attachment on a new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Postprocessing action for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Uploaded file content type for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Uploaded file length for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Uploaded file name for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Uploaded text for the affected item attachment on a new item request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL for the affected item attachment on a new item request.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Name for the affected item attachment on a new item request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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":{
        "CancelComments":{
            "maxLength":240,
            "type":"string",
            "description":"Comments for the cancel action.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the translation.",
            "nullable":false,
            "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
        },
        "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"
            }
        }
    }
}

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

  Context Segment
• BaseChangeMgmtTypeCode: string
  Maximum Length: 30
• ChangeId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "BaseChangeMgmtTypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ChangeId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

attachments

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

Parameters:

• NewItemRequestId: $request.path.NewItemRequestId

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

newItemRequestAffectedItems

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

Parameters:

• NewItemRequestId: $request.path.NewItemRequestId

New item line of the new item request object.

newItemRequestsDFF

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

Parameters:

• NewItemRequestId: $request.path.NewItemRequestId

Back to Top

Examples

This example describes how to get one new item request.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/newItemRequests/NewItemRequestId"

For example, the following command gets one new item request:

curl -u username:password "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534"

Example Response Body

The following shows an example 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": "High",
	"NewItemRequestId": 300100151858534,
	"NewItemRequestType": "New Item Request",
	"NewItemRequestName": "PLM26733_RestWS_NIR00061_ZCH",
	"NewItemRequestNumber": "PLM26733_RestWS_NIR00061_ZCH",
	"ApprovalStatusValue": "Not submitted for approval",
	"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