Jump to

• Request
• Response
• Examples

Update a trading partner item

patch

/fscmRestApi/resources/11.13.18.05/tradingPartnerItems/{TradingPartnerItemId}

Request

Path Parameters

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

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The Attachments resource manages the attachments of the trading partner items.
• DFF: array DFF
• EndDate: string (date)
  Title: End Date

  Date when the trading partner item becomes ineffective.
• StartDate: string (date)
  Title: Start Date

  Date when the trading partner item becomes effective.
• TradingPartnerItemDescription: string
  Title: Trading Partner Item Description

  Maximum Length: 240

  Description of the trading partner item.
• TradingPartnerItemNumber: string
  Title: Trading Partner Item

  Maximum Length: 150

  Number that identifies a trading partner item such as supplier item, customer item, competitor item, and manufacturer part number.
• TradingPartnerItemStatus: string
  Maximum Length: 255

  Status of the trading partner item. A list of accepted values is defined in the lookup type ORA_ACA_MFR_PART_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the trading partner item becomes effective.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "TradingPartnerItemNumber":{
            "title":"Trading Partner Item",
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies a trading partner item such as supplier item, customer item, competitor item, and manufacturer part number.",
            "nullable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradingPartnerItems-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "TradingPartnerItemStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the trading partner item. A list of accepted values is defined in the lookup type ORA_ACA_MFR_PART_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TradingPartnerItemDescription":{
            "title":"Trading Partner Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the trading partner item.",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the trading partner item becomes ineffective.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            }
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments of the trading partner items.",
            "items":{
                "$ref":"#/components/schemas/tradingPartnerItems-Attachments-item-patch-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments of the trading partner items.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the attachments of the trading partner items.",
    "items":{
        "$ref":"#/components/schemas/tradingPartnerItems-Attachments-item-patch-request"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object tradingPartnerItems-DFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradingPartnerItems-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• AttachmentDFF: array AttachmentDFF
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
• ContentRepositoryFileShared: boolean
  Title: Shared

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

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that indicates the type of data of trading partner item attachment. Valid values include WEB_PAGE, TEXT, or FILE.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the trading partner item attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path to the folder in which the trading partner item attachment file is uploaded.
• 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 indicates the error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the file attached to the trading partner item.
• FileUrl: string
  Title: File Url

  URL of the trading partner item attachment file.
• Title: string
  Title: Title

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

  Type of the file content of the trading partner item attachment.
• UploadedFileLength: integer
  Title: File Size

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

  Name of the uploaded file of the trading partner item attachment.
• UploadedText: string
  Title: Uploaded Text

  Content of the attached text file.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID for trading partner item attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the trading partner item attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the trading partner item 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 indicates the type of data of trading partner item attachment. Valid values include WEB_PAGE, TEXT, or FILE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the file attached to the trading partner item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the trading partner item attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID for trading partner item attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of the trading partner item attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file of the trading partner item attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachmentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradingPartnerItems-Attachments-AttachmentDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the trading partner item attachment 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 trading partner attachment is shared. If false, then it's not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of the file content of the trading partner item attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that indicates the error, if any, for 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"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Path to the folder in which the trading partner item attachment file is uploaded.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Content of the attached text file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : AttachmentDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradingPartnerItems-Attachments-AttachmentDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AttachedDocumentId: integer (int64)

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : tradingPartnerItems-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Trading Partner Item Context

  Maximum Length: 30

  Trading Partner Item Context
• __FLEX_Context_DisplayValue: string
  Title: Trading Partner Item Context

  Trading Partner Item Context

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Trading Partner Item Context",
            "type":"string",
            "description":"Trading Partner Item Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Trading Partner Item Context",
            "maxLength":30,
            "type":"string",
            "description":"Trading Partner Item Context",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "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 : tradingPartnerItems-item-response

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The Attachments resource manages the attachments of the trading partner items.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the trading partner item.
• CreationDateTime: string (date-time)
  Read Only: true

  Date when the user created the trading partner item.
• DFF: array DFF
• EndDate: string (date)
  Title: End Date

  Date when the trading partner item becomes ineffective.
• LastUpdateDateTime: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the trading partner item.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the trading partner item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RegistryId: string
  Maximum Length: 255

  Value that uniquely identifies the party.
• StartDate: string (date)
  Title: Start Date

  Date when the trading partner item becomes effective.
• TradingPartnerId: integer (int64)
  Title: Trading Partner

  Value that uniquely identifies the trading partner.
• TradingPartnerItemDescription: string
  Title: Trading Partner Item Description

  Maximum Length: 240

  Description of the trading partner item.
• TradingPartnerItemId: integer (int64)
  Title: Trading Partner Item ID

  Value that uniquely identifies the trading partner item.
• TradingPartnerItemNumber: string
  Title: Trading Partner Item

  Maximum Length: 150

  Number that identifies a trading partner item such as supplier item, customer item, competitor item, and manufacturer part number.
• TradingPartnerItemStatus: string
  Maximum Length: 255

  Status of the trading partner item. A list of accepted values is defined in the lookup type ORA_ACA_MFR_PART_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.
• TradingPartnerName: string
  Maximum Length: 255

  Name of the trading partner.
• TradingPartnerType: string
  Maximum Length: 255

  Type of the trading partner.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the trading partner item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradingPartnerId":{
            "title":"Trading Partner",
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the trading partner item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when the user most recently updated the trading partner item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradingPartnerItemNumber":{
            "title":"Trading Partner Item",
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies a trading partner item such as supplier item, customer item, competitor item, and manufacturer part number.",
            "nullable":false,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradingPartnerItems-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "TradingPartnerItemDescription":{
            "title":"Trading Partner Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the trading partner item.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerItemId":{
            "title":"Trading Partner Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradingPartnerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the trading partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the trading partner item becomes ineffective.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the attachments of the trading partner items.",
            "items":{
                "$ref":"#/components/schemas/tradingPartnerItems-Attachments-item-response"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the trading partner item becomes effective.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date when the user created the trading partner item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradingPartnerItemStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the trading partner item. A list of accepted values is defined in the lookup type ORA_ACA_MFR_PART_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RegistryId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the party.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the trading partner item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradingPartnerType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the trading partner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the attachments of the trading partner items.

Show Source

• Array of: object tradingPartnerItems-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the attachments of the trading partner items.",
    "items":{
        "$ref":"#/components/schemas/tradingPartnerItems-Attachments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object tradingPartnerItems-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradingPartnerItems-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : tradingPartnerItems-Attachments-item-response

Type: object

Show Source

• AttachmentDFF: array AttachmentDFF
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
• ContentRepositoryFileShared: boolean
  Title: Shared

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

  Read Only: true

  Maximum Length: 255

  User who created the trading partner item attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that indicates the type of data of trading partner item attachment. Valid values include WEB_PAGE, TEXT, or FILE.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the trading partner item attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path to the folder in which the trading partner item attachment file is uploaded.
• DocumentURL: string
  Read Only: true

  URL of the trading partner item attachment.
• 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 indicates the error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the file attached to the trading partner item.
• FileUrl: string
  Title: File Url

  URL of the trading partner item attachment file.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the user most recently updated the trading partner item attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the trading partner item attachment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 255

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

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

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

  Type of the file content of the trading partner item attachment.
• UploadedFileLength: integer
  Title: File Size

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

  Name of the uploaded file of the trading partner item attachment.
• UploadedText: string
  Title: Uploaded Text

  Content of the attached text file.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID for trading partner item attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the trading partner item attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Display name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the trading partner 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 trading partner item attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the file attached to the trading partner item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID for trading partner item 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 of the trading partner item attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of the file content of the trading partner item 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"
            }
        },
        "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":"Size of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the trading partner item attachment.",
            "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":"Display name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.",
            "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 trading partner item attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the type of data of trading partner item attachment. Valid values include WEB_PAGE, TEXT, or FILE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentURL":{
            "type":"string",
            "description":"URL of the trading partner item attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the trading partner item 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 uploaded file of the trading partner item attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachmentDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradingPartnerItems-Attachments-AttachmentDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the trading partner item attachment 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 trading partner attachment is shared. If false, then it's not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that indicates the error, 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":"Path to the folder in which the trading partner item attachment file is uploaded.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Content of the attached text file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Name of the trading partner item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated the trading partner item attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":255,
            "type":"string",
            "description":"Login that the user used when updating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : AttachmentDFF

Type: array

Show Source

• Array of: object tradingPartnerItems-Attachments-AttachmentDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradingPartnerItems-Attachments-AttachmentDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : tradingPartnerItems-Attachments-AttachmentDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AttachedDocumentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "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"
    }
}

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 : tradingPartnerItems-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Trading Partner Item Context

  Maximum Length: 30

  Trading Partner Item Context
• __FLEX_Context_DisplayValue: string
  Title: Trading Partner Item Context

  Trading Partner Item Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TpItemId: integer (int64)
  Title: Trading Partner Item ID
• TpType: string
  Title: Trading Partner Type

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TpItemId":{
            "title":"Trading Partner Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Trading Partner Item Context",
            "type":"string",
            "description":"Trading Partner Item Context",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "TpType":{
            "title":"Trading Partner Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"list",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"10011"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Trading Partner Item Context",
            "maxLength":30,
            "type":"string",
            "description":"Trading Partner Item Context",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "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/tradingPartnerItems/{TradingPartnerItemId}/child/Attachments

Parameters:

• TradingPartnerItemId: $request.path.TradingPartnerItemId

The Attachments resource manages the attachments of the trading partner items.

DFF

Operation: /fscmRestApi/resources/11.13.18.05/tradingPartnerItems/{TradingPartnerItemId}/child/DFF

Parameters:

• TradingPartnerItemId: $request.path.TradingPartnerItemId

TradingPartnerItemStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_ACA_MFR_PART_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: TradingPartnerItemStatus; Target Attribute: Meaning
• Display Attribute: Meaning, LookupCode

TradingPartnerTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DEGP_TP_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: TradingPartnerType; Target Attribute: Meaning
• Display Attribute: Meaning

Back to Top

Examples

This example describes how to update a trading partner item.

Example cURL Command

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

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

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

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

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 updates.

{
	"TradingPartnerItemDescription":"This part is an assembly of FICO components"
}

Example Response Body

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

{
	"TradingPartnerItemId": 300100194236343,
	"TradingPartnerItemNumber": "M1234",
	"TradingPartnerItemDescription": "This part is an assembly of FICO components",
	"TradingPartnerItemStatus": null,
	"TradingPartnerType": "SUPPLIER",
	"TradingPartnerId": 1000,
	"TradingPartnerName": "World of Business",
	"RegistryId": "1000",
	"StartDate": "2020-07-10",
	"EndDate": null,
	"CreationDateTime": "2020-07-10T09:34:03.001+00:00",
	"LastUpdateDateTime": "2020-07-10T09:39:42+00:00",
	"CreatedBy": "X",
	"LastUpdateLogin": "A9F34275918F13B3E0537AA8F00AE37D",
	"LastUpdatedBy": "X",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItems/300100194236343",
		"name": "tradingPartnerItems",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
		}
	},
	{
		"rel": "canonical",
		"href": "XXX.com:443/fscmRestApi/resources/11.13.18.05/tradingPartnerItems/300100194236343",
		"name": "tradingPartnerItems",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://XXX/fscmRestApi/resources/11.13.18.05/tradingPartnerItems/300100194236343/child/Attachments",
		"name": "Attachments",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://XXX/fscmRestApi/resources/11.13.18.05/tradingPartnerItems/300100194236343/child/DFF",
		"name": "DFF",
		"kind": "collection"
	}
	]
}

Back to Top