Create one business classification

post

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

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Attachments
    Title: Attachments
    The Attachments resource manages attachments for a supplier business classification.
  • Title: Expiration Date
    Date when the certificate that the certifying agency issues for the business classification expires.
  • Title: Certificate Number
    Maximum Length: 80
    Certificate that the certifying agency issues for the business classification.
  • Title: Start Date
    Date when the certificate that the certifying agency issues for the business classification goes into effect.
  • Title: Certifying Agency
    Maximum Length: 255
    Agency that certifies the business classification for the supplier.
  • Title: Certifying Agency
    Value that uniquely identifies the agency that certifies the business classification for the supplier.
  • Title: Classification
    Maximum Length: 80
    Classification for the supplier business.
  • 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.
  • Title: Confirmed On
    Date when the application confirmed the business classification for the supplier.
  • 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.
  • 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 does not specify the agency you require.
  • Value that uniquely identifies the person in the supplier organization who provides the business classification details.
  • Email of the person in the supplier organization who provides business classification details.
  • First name of the person in the supplier organization who provides business classification details.
  • Last name of the person in the supplier organization who provides business classification details.
  • Title: Subclassification
    Maximum Length: 80
    Describes the subclassification when a minority owns the business classification.
  • Title: Subclassification
    Maximum Length: 240
    Abbreviation that identifies the subclassification when a minority owns the 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.
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages attachments for a supplier business classification.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
    Title: Attachments
    The Attachments resource manages attachments for a supplier business classification.
  • Title: Expiration Date
    Date when the certificate that the certifying agency issues for the business classification expires.
  • Title: Certificate Number
    Maximum Length: 80
    Certificate that the certifying agency issues for the business classification.
  • Title: Start Date
    Date when the certificate that the certifying agency issues for the business classification goes into effect.
  • Title: Certifying Agency
    Maximum Length: 255
    Agency that certifies the business classification for the supplier.
  • Title: Certifying Agency
    Value that uniquely identifies the agency that certifies the business classification for the supplier.
  • Title: Classification
    Maximum Length: 80
    Classification for the supplier business.
  • 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.
  • Read Only: true
    Value that uniquely identifies the classification for the supplier business.
  • Title: Confirmed On
    Date when the application confirmed the business classification for the supplier.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the supplier record.
  • Title: Creation Date
    Read Only: true
    Date when the user created the supplier record.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the supplier record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the supplier record.
  • Links
  • 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.
  • 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 does not specify the agency you require.
  • Value that uniquely identifies the person in the supplier organization who provides the business classification details.
  • Email of the person in the supplier organization who provides business classification details.
  • First name of the person in the supplier organization who provides business classification details.
  • Last name of the person in the supplier organization who provides business classification details.
  • Title: Status
    Read Only: true
    Maximum Length: 255
    Status of the business classification for the supplier.
  • Title: Subclassification
    Maximum Length: 80
    Describes the subclassification when a minority owns the business classification.
  • Title: Subclassification
    Maximum Length: 240
    Abbreviation that identifies the subclassification when a minority owns the 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.
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages attachments for a supplier business classification.
Show Source
Nested Schema : suppliers-businessClassifications-attachments-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to create a business classification.

Example cURL Command

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

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

Example Request Body

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

{
	"ClassificationCode": "HUB_ZONE",
	"Classification": "Hub Zone",
	"SubclassificationCode": null,
	"Subclassification": null,      
	"CertifyingAgencyId": 4,
	"CertifyingAgency": "National Small Business Administration",
	"OtherCertifyingAgency": null,
	"CertificateNumber": "0099",
	"CertificateStartDate": "2019-11-12",
	"CertificateExpirationDate": "2029-11-13",
	"Notes": "We specialize in hand made products"
	
}

Example Response Body

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

{
	"ClassificationId": 300100185166133,
	"ClassificationCode": "HUB_ZONE",
	"Classification": "Hub Zone",
	"SubclassificationCode": null,
	"Subclassification": null,
	"Status": "CURRENT",
	"CertifyingAgencyId": 4,
	"CertifyingAgency": "National Small Business Administration",
	"OtherCertifyingAgency": null,
	"CertificateNumber": "0099",
	"CertificateStartDate": "2019-11-12",
	"CertificateExpirationDate": "2029-11-13",
	"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/999992000325809/child/businessClassifications/300100185166133",
		"name": "businessClassifications",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000325809/child/businessClassifications/300100185166133",
		"name": "businessClassifications",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000325809",
		"name": "suppliers",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000325809/child/businessClassifications/300100185166133/lov/BusinessClassificationLookup",
		"name": "BusinessClassificationLookup",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000325809/child/businessClassifications/300100185166133/lov/SubclassificationLookup",
		"name": "SubclassificationLookup",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000325809/child/businessClassifications/300100185166133/lov/CertifyingAgencyLookup",
		"name": "CertifyingAgencyLookup",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/suppliers/999992000325809/child/businessClassifications/300100185166133/child/attachments",
		"name": "attachments",
		"kind": "collection"
	}
	]
}

Back to Top