Get one classification
get
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/businessClassifications/{ClassificationId}
Request
Path Parameters
-
ClassificationId(required): integer(int64)
Value that uniquely identifies the classification for the supplier business.
-
SupplierId(required): integer(int64)
Value that uniquely identifies the supplier.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : suppliers-businessClassifications-item-response
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages attachments for a supplier business classification. -
CertificateExpirationDate: string
(date)
Title:
Expiration Date
Date when 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 when the certificate that 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. -
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 record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the supplier record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the supplier record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the supplier record. -
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 does not 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 person in the supplier organization who provides business classification details.
-
ProvidedByUserFirstName: string
First name of the person in the supplier organization who provides business classification details.
-
ProvidedByUserLastName: string
Last name of the person in the supplier organization who provides business classification details.
-
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 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : suppliers-businessClassifications-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a question. It is a primary key that the application creates when the user attaches a document to the question. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Sign in details for the user who created the attachment for the question. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the content in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that a user attached to the question. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Sign in details of the user who most recently updated the document that a user attached to the question. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Sign in details for the user used who updated the attachment for the question. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Sign in details that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- attachments
-
Parameters:
- ClassificationId:
$request.path.ClassificationId
- SupplierId:
$request.path.SupplierId
The Attachments resource manages attachments for a supplier business classification. - ClassificationId:
Examples
This example describes how to get one classification.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/businessClassifications/ClassificationId"
For example, the following command gets one classification where the classification identifier is 300100153044415:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044415"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ClassificationId" : 300100153044415, "ClassificationCode" : "HUB_ZONE", "Classification" : "Hub Zone", "SubclassificationCode" : null, "Subclassification" : null, "Status" : "CURRENT", "CertifyingAgencyId" : 85, "CertifyingAgency" : "Hub Zone Association, Chicago", "OtherCertifyingAgency" : null, "CertificateNumber" : "424A09-343", "CertificateStartDate" : "2017-06-01", "CertificateExpirationDate" : "2019-05-31", "Notes" : null, "ProvidedByUserFirstName" : null, "ProvidedByUserLastName" : null, "ConfirmedOnDate" : "2018-06-01", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044415", "name" : "businessClassifications", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044415", "name" : "businessClassifications", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388", "name" : "suppliers", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044415/child/attachments", "name" : "attachments", "kind" : "collection" } ] }