Jump to

• Request
• Response
• Examples

Update one business classification

patch

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/businessClassifications/{ClassificationId}

Request

Path Parameters

• ClassificationId(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=
• SupplierId(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 is used to view, create, and update attachments.
• CertificateExpirationDate: string (date)
  Title: Expiration Date

  Date on which the certificate that the certifying agency issues for the business classification expires.
• CertificateNumber: string
  Title: Certificate Number

  Maximum Length: 80

  Certificate that the certifying agency issues for the business classification.
• CertificateStartDate: string (date)
  Title: Start Date

  Date on which the certificate, which the certifying agency issues for the business classification, goes into effect.
• CertifyingAgency: string
  Title: Certifying Agency

  Maximum Length: 255

  Agency that certifies the business classification for the supplier. This attribute is used when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.
• CertifyingAgencyId: integer (int64)
  Title: Certifying Agency

  Value that uniquely identifies the agency that certifies the business classification for the supplier.
• Classification: string
  Title: Classification

  Maximum Length: 80

  Classification for the supplier business.
• ClassificationCode: string
  Title: Classification

  Maximum Length: 30

  Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task.
• ConfirmedOnDate: string (date)
  Title: Confirmed On

  Date when the application confirmed the business classification for the supplier.
• Notes: string
  Title: Notes

  Maximum Length: 1000

  Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes.
• OtherCertifyingAgency: string
  Title: Other Certifying Agency

  Maximum Length: 255

  Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.
• ProvidedByContactId: integer (int64)
  Value that uniquely identifies the person in the supplier organization who provides the business classification details.
• ProvidedByEmail: string
  Email of the supplier contact who has provided the classification information.
• ProvidedByUserFirstName: string
  First Name of the supplier contact who has provided the classification information.
• ProvidedByUserLastName: string
  Last Name of the supplier contact who has provided the classification information.
• Subclassification: string
  Title: Subclassification

  Maximum Length: 80

  Describes the subclassification when a minority owns the business classification.
• SubclassificationCode: string
  Title: Subclassification

  Maximum Length: 240

  Abbreviation that identifies the subclassification when a minority owns a business classification. A list of accepted values is defined in the lookup type POZ_MINORITY_GROUP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.

{
    "type":"object",
    "properties":{
        "CertificateExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date on which the certificate that the certifying agency issues for the business classification expires.",
            "format":"date",
            "nullable":true
        },
        "CertificateNumber":{
            "title":"Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"Certificate that the certifying agency issues for the business classification.",
            "nullable":true
        },
        "CertificateStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date on which the certificate, which the certifying agency issues for the business classification, goes into effect.",
            "format":"date",
            "nullable":true
        },
        "CertifyingAgency":{
            "title":"Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Agency that certifies the business classification for the supplier. This attribute is used when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CertifyingAgencyId":{
            "title":"Certifying Agency",
            "type":"integer",
            "description":"Value that uniquely identifies the agency that certifies the business classification for the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Classification":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"Classification for the supplier business.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ClassificationCode":{
            "title":"Classification",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task.",
            "nullable":false
        },
        "ConfirmedOnDate":{
            "title":"Confirmed On",
            "type":"string",
            "description":"Date when the application confirmed the business classification for the supplier.",
            "format":"date",
            "nullable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":1000,
            "type":"string",
            "description":"Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes.",
            "nullable":true
        },
        "OtherCertifyingAgency":{
            "title":"Other Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.",
            "nullable":true
        },
        "ProvidedByContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person in the supplier organization who provides the business classification details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "ProvidedByEmail":{
            "type":"string",
            "description":"Email of the supplier contact who has provided the classification information.",
            "nullable":true,
            "x-queryable":false
        },
        "ProvidedByUserFirstName":{
            "type":"string",
            "description":"First Name of the supplier contact who has provided the classification information.",
            "nullable":true,
            "x-queryable":false
        },
        "ProvidedByUserLastName":{
            "type":"string",
            "description":"Last Name of the supplier contact who has provided the classification information.",
            "nullable":true,
            "x-queryable":false
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"Describes the subclassification when a minority owns the business classification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubclassificationCode":{
            "title":"Subclassification",
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the subclassification when a minority owns a business classification. A list of accepted values is defined in the lookup type POZ_MINORITY_GROUP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/suppliers-businessClassifications-attachments-item-patch-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object suppliers-businessClassifications-attachments-item-patch-request

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

Nested Schema : suppliers-businessClassifications-attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

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

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

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

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

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

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

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

  Maximum Length: 2048

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

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

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

  The URL of a web page type attachment.

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

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 : suppliers-businessClassifications-item-response

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CertificateExpirationDate: string (date)
  Title: Expiration Date

  Date on which the certificate that the certifying agency issues for the business classification expires.
• CertificateNumber: string
  Title: Certificate Number

  Maximum Length: 80

  Certificate that the certifying agency issues for the business classification.
• CertificateStartDate: string (date)
  Title: Start Date

  Date on which the certificate, which the certifying agency issues for the business classification, goes into effect.
• CertifyingAgency: string
  Title: Certifying Agency

  Maximum Length: 255

  Agency that certifies the business classification for the supplier. This attribute is used when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.
• CertifyingAgencyId: integer (int64)
  Title: Certifying Agency

  Value that uniquely identifies the agency that certifies the business classification for the supplier.
• Classification: string
  Title: Classification

  Maximum Length: 80

  Classification for the supplier business.
• ClassificationCode: string
  Title: Classification

  Maximum Length: 30

  Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task.
• ClassificationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the classification for the supplier business.
• ConfirmedOnDate: string (date)
  Title: Confirmed On

  Date when the application confirmed the business classification for the supplier.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the supplier business classification.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the application created the supplier business classification.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the supplier business classification row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the supplier business classification row.
• links: array Links
  Title: Links

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

  Maximum Length: 1000

  Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes.
• OtherCertifyingAgency: string
  Title: Other Certifying Agency

  Maximum Length: 255

  Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.
• ProvidedByContactId: integer (int64)
  Value that uniquely identifies the person in the supplier organization who provides the business classification details.
• ProvidedByContactName: string
  Read Only: true

  Maximum Length: 255

  Full name of the supplier contact who has provided the classification information.
• ProvidedByEmail: string
  Email of the supplier contact who has provided the classification information.
• ProvidedByUserFirstName: string
  First Name of the supplier contact who has provided the classification information.
• ProvidedByUserLastName: string
  Last Name of the supplier contact who has provided the classification information.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 255

  Status of the business classification for the supplier.
• Subclassification: string
  Title: Subclassification

  Maximum Length: 80

  Describes the subclassification when a minority owns the business classification.
• SubclassificationCode: string
  Title: Subclassification

  Maximum Length: 240

  Abbreviation that identifies the subclassification when a minority owns a business classification. A list of accepted values is defined in the lookup type POZ_MINORITY_GROUP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.

{
    "type":"object",
    "properties":{
        "CertificateExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date on which the certificate that the certifying agency issues for the business classification expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertificateNumber":{
            "title":"Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"Certificate that the certifying agency issues for the business classification.",
            "nullable":true,
            "x-queryable":true
        },
        "CertificateStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date on which the certificate, which the certifying agency issues for the business classification, goes into effect.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertifyingAgency":{
            "title":"Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Agency that certifies the business classification for the supplier. This attribute is used when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CertifyingAgencyId":{
            "title":"Certifying Agency",
            "type":"integer",
            "description":"Value that uniquely identifies the agency that certifies the business classification for the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"Classification for the supplier business.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClassificationCode":{
            "title":"Classification",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task.",
            "nullable":false,
            "x-queryable":true
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification for the supplier business.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ConfirmedOnDate":{
            "title":"Confirmed On",
            "type":"string",
            "description":"Date when the application confirmed the business classification for the supplier.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier business classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the application created the supplier business classification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the supplier business classification row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the supplier business classification row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Notes":{
            "title":"Notes",
            "maxLength":1000,
            "type":"string",
            "description":"Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherCertifyingAgency":{
            "title":"Other Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area doesn't specify the agency you require.",
            "nullable":true,
            "x-queryable":true
        },
        "ProvidedByContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person in the supplier organization who provides the business classification details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProvidedByContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Full name of the supplier contact who has provided the classification information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProvidedByEmail":{
            "type":"string",
            "description":"Email of the supplier contact who has provided the classification information.",
            "nullable":true,
            "x-queryable":false
        },
        "ProvidedByUserFirstName":{
            "type":"string",
            "description":"First Name of the supplier contact who has provided the classification information.",
            "nullable":true,
            "x-queryable":false
        },
        "ProvidedByUserLastName":{
            "type":"string",
            "description":"Last Name of the supplier contact who has provided the classification information.",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the business classification for the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CertificateExpirationDate",
                    "CertificateStartDate"
                ]
            },
            "x-queryable":true
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"Describes the subclassification when a minority owns the business classification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubclassificationCode":{
            "title":"Subclassification",
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the subclassification when a minority owns a business classification. A list of accepted values is defined in the lookup type POZ_MINORITY_GROUP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/suppliers-businessClassifications-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object suppliers-businessClassifications-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/suppliers-businessClassifications-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 : suppliers-businessClassifications-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

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

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

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

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

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

  Maximum Length: 2048

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

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

attachments

Operation: /fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/businessClassifications/{ClassificationId}/child/attachments

Parameters:

• ClassificationId: $request.path.ClassificationId
• SupplierId: $request.path.SupplierId

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

Back to Top

Examples

This example describes how to update a business classification.

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/suppliers/SupplierId/child/businessClassifications/ClassificationId"

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.

{  
	"CertificateStartDate": "2019-11-12",
	"CertificateExpirationDate": "2022-11-11"
}

Example Response Body

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

{
	"ClassificationId": 300100184758008,
	"ClassificationCode": "HUB_ZONE",
	"Classification": "Hub Zone",
	"SubclassificationCode": null,
	"Subclassification": null,
	"Status": "CURRENT",
	"CertifyingAgencyId": 3,
	"CertifyingAgency": "Agency_1",
	"OtherCertifyingAgency": null,
	"CertificateNumber": "0099",
	"CertificateStartDate": "2019-11-12",
	"CertificateExpirationDate": "2022-11-11",
	"Notes": "We specialize in hand made products",
	"ProvidedByUserFirstName": null,
	"ProvidedByUserLastName": null,
	"ConfirmedOnDate": null,
	"ProvidedByContactId": null,
	"ProvidedByEmail": null,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/businessClassifications/300100184758008",
		"name": "businessClassifications",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/businessClassifications/300100184758008",
		"name": "businessClassifications",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527",
		"name": "suppliers",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/businessClassifications/300100184758008/lov/BusinessClassificationLookup",
		"name": "BusinessClassificationLookup",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/businessClassifications/300100184758008/lov/SubclassificationLookup",
		"name": "SubclassificationLookup",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/businessClassifications/300100184758008/lov/CertifyingAgencyLookup",
		"name": "CertifyingAgencyLookup",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000331527/child/businessClassifications/300100184758008/child/attachments",
		"name": "attachments",
		"kind": "collection"
	}
	]
}

Back to Top