Create manufacturers
post
/fscmRestApi/resources/11.13.18.05/manufacturers
Request
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.
-
Upsert-Mode:
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
- application/json
Root Schema : schema
Type:
Show Source
object-
Address1: string
Title:
Address Line 1Maximum Length:240First line in the address of the manufacturer. -
Address2: string
Title:
Address Line 2Maximum Length:240Second line in the address of the manufacturer. -
Address3: string
Title:
Address Line 3Maximum Length:240Third line in the address of the manufacturer. -
Address4: string
Title:
Address Line 4Maximum Length:240Fourth line in the address of the manufacturer. -
AddressElementAttribute1: string
Title:
Additional Address Element 1Maximum Length:150Address one element used in flexible address formats. -
AddressElementAttribute2: string
Title:
Additional Address Element 2Maximum Length:150Address two element used in flexible address formats. -
AddressElementAttribute3: string
Title:
Additional Address Element 3Maximum Length:150Address three element used in flexible address formats. -
AddressElementAttribute4: string
Title:
Additional Address Element 4Maximum Length:150Address four element used in flexible address formats. -
AddressElementAttribute5: string
Title:
Additional Address Element 5Maximum Length:150Address five element used in flexible address formats. -
AddressStyle: string
Maximum Length:
30Used to view the different styles in which an address can be formatted. There are multiple address formats such as general address, rural address, and military address. -
Attachments: array
Attachments
Title:
AttachmentsAn attachment is a file provided by a manufacturer for supporting information. -
Building: string
Title:
BuildingMaximum Length:240Building name or number of an address. -
City: string
Title:
CityMaximum Length:60City of the manufacturer. -
Comments: string
Title:
Manufacturer DescriptionMaximum Length:2000Description of the manufacturer. -
Country: string
Title:
CountryMaximum Length:2Country of the manufacturer. -
CountryName: string
Title:
CountryName of the country. -
County: string
Title:
CountyMaximum Length:60County of the manufacturer. -
DUNSNumber: string
Title:
D-U-N-S NumberMaximum Length:30Unique nine-character number used to identify the manufacturer. -
FloorNumber: string
Title:
FloorMaximum Length:40Floor number of an address, or of a building when the building number is provided. -
HouseType: string
Title:
House TypeMaximum Length:30Type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
manufacturerEFF: array
manufacturerEFF
-
ManufacturerId(required): integer
(int64)
Value that uniquely identifies the manufacturer.
-
OrganizationName(required): string
Title:
ManufacturerMaximum Length:360Name of the manufacturer. -
PartyType(required): string
Title:
Party TypeMaximum Length:30Type of party of the manufacturer. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the manufacturer. -
PostalPlus4Code: string
Title:
Postal Code ExtensionMaximum Length:20Four-digit extension of the United States postal ZIP code in the address. -
PrimaryPhoneExtension: string
Maximum Length:
20Primary phone extension of the manufacturer. -
PrimaryPhoneNumber: string
Maximum Length:
40Primary phone number of the manufacturer. -
Province: string
Title:
ProvinceMaximum Length:60Province of the manufacturer. -
RegistryId(required): string
Title:
Registry IDMaximum Length:30Value that uniquely identifies the manufacturer by registry ID. -
State: string
Title:
StateMaximum Length:60State of the address. -
StateName: string
Title:
StateName of the state. -
Status: string
Title:
StatusMaximum Length:1Default Value:AStatus of the manufacturer.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsAn attachment is a file provided by a manufacturer for supporting information.
Show Source
Nested Schema : manufacturerEFF
Type:
Show Source
array-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "ALL_MANUFACTURERS":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-post-request" } }
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of a manufacturer attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment resides. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the document version from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents of the attached document expire. -
FileContents: string
(byte)
Title:
File ContentsContents of the attached document. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file that's attached. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) that locates the attachment. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) of a web page type attachment.
Nested Schema : Discriminator: CategoryCode
Type:
objectDiscriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-post-request
Type:
Show Source
object-
CategoryCode: string
Maximum Length:
30Default Value:ALL_MANUFACTURERS -
ManufacturerId: string
Maximum Length:
255
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.
Root Schema : manufacturers-item-response
Type:
Show Source
object-
Address1: string
Title:
Address Line 1Maximum Length:240First line in the address of the manufacturer. -
Address2: string
Title:
Address Line 2Maximum Length:240Second line in the address of the manufacturer. -
Address3: string
Title:
Address Line 3Maximum Length:240Third line in the address of the manufacturer. -
Address4: string
Title:
Address Line 4Maximum Length:240Fourth line in the address of the manufacturer. -
AddressElementAttribute1: string
Title:
Additional Address Element 1Maximum Length:150Address one element used in flexible address formats. -
AddressElementAttribute2: string
Title:
Additional Address Element 2Maximum Length:150Address two element used in flexible address formats. -
AddressElementAttribute3: string
Title:
Additional Address Element 3Maximum Length:150Address three element used in flexible address formats. -
AddressElementAttribute4: string
Title:
Additional Address Element 4Maximum Length:150Address four element used in flexible address formats. -
AddressElementAttribute5: string
Title:
Additional Address Element 5Maximum Length:150Address five element used in flexible address formats. -
AddressStyle: string
Maximum Length:
30Used to view the different styles in which an address can be formatted. There are multiple address formats such as general address, rural address, and military address. -
Attachments: array
Attachments
Title:
AttachmentsAn attachment is a file provided by a manufacturer for supporting information. -
Building: string
Title:
BuildingMaximum Length:240Building name or number of an address. -
City: string
Title:
CityMaximum Length:60City of the manufacturer. -
Comments: string
Title:
Manufacturer DescriptionMaximum Length:2000Description of the manufacturer. -
Country: string
Title:
CountryMaximum Length:2Country of the manufacturer. -
CountryName: string
Title:
CountryName of the country. -
County: string
Title:
CountyMaximum Length:60County of the manufacturer. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the manufacturer. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the manufacturer was created. -
DUNSNumber: string
Title:
D-U-N-S NumberMaximum Length:30Unique nine-character number used to identify the manufacturer. -
FloorNumber: string
Title:
FloorMaximum Length:40Floor number of an address, or of a building when the building number is provided. -
HouseType: string
Title:
House TypeMaximum Length:30Type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate when the manufacturer was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the manufacturer. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
manufacturerEFF: array
manufacturerEFF
-
ManufacturerId: integer
(int64)
Value that uniquely identifies the manufacturer.
-
OrganizationName: string
Title:
ManufacturerMaximum Length:360Name of the manufacturer. -
PartyType: string
Title:
Party TypeMaximum Length:30Type of party of the manufacturer. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the manufacturer. -
PostalPlus4Code: string
Title:
Postal Code ExtensionMaximum Length:20Four-digit extension of the United States postal ZIP code in the address. -
PrimaryPhoneExtension: string
Maximum Length:
20Primary phone extension of the manufacturer. -
PrimaryPhoneNumber: string
Maximum Length:
40Primary phone number of the manufacturer. -
Province: string
Title:
ProvinceMaximum Length:60Province of the manufacturer. -
RegistryId: string
Title:
Registry IDMaximum Length:30Value that uniquely identifies the manufacturer by registry ID. -
State: string
Title:
StateMaximum Length:60State of the address. -
StateName: string
Title:
StateName of the state. -
Status: string
Title:
StatusMaximum Length:1Default Value:AStatus of the manufacturer.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsAn attachment is a file provided by a manufacturer for supporting information.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : manufacturerEFF
Type:
Show Source
array-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "ALL_MANUFACTURERS":"#/components/schemas/oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response" } }
Nested Schema : manufacturers-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of a manufacturer attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the manufacturer attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the manufacturer attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the manufacturer attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment resides. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the document version from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents of the attached document expire. -
FileContents: string
(byte)
Title:
File ContentsContents of the attached document. -
FileName: string
Title:
File NameMaximum Length:2048Name of the file that's attached. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the user most recently updated the attached document. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the document. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : Discriminator: CategoryCode
Type:
objectDiscriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_flex_scm_productCatalogManagement_manufacturerEff_manufacturer_categories_view_j__manufacturerAllManufacturersPrivateVO-item-response
Type:
Show Source
object-
CategoryCode: string
Maximum Length:
30Default Value:ALL_MANUFACTURERS -
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerId: string
Maximum Length:
255
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- manufacturersUniqID:
$request.path.manufacturersUniqID
An attachment is a file provided by a manufacturer for supporting information. - manufacturersUniqID:
- manufacturerEFF
-
Operation: /fscmRestApi/resources/11.13.18.05/manufacturers/{manufacturersUniqID}/child/manufacturerEFFParameters:
- manufacturersUniqID:
$request.path.manufacturersUniqID
- manufacturersUniqID:
Examples
This example describes how to create one manufacturer.
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/manufacturers"
Example Request Body
The following example includes the contents of the request body in JSON format:
{
"OrganizationName": "Test rest 2"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"AttributeCategory": null,
"CorpCurrencyCode": null,
"CreatedBy": "PLM_AUTO",
"CreationDate": "2022-04-04T19:44:50+00:00",
"CurcyConvRateType": null,
"CurrencyCode": null,
"IsActiveFlag": null,
"IsPrivateFlag": null,
"LastUpdateDate": "2022-04-04T19:44:51.328+00:00",
"LastUpdateLogin": "DB7D1802BA58746EE0531929F80AA460",
"LastUpdatedBy": "PLM_AUTO",
"ManufacturerId": 300100550108403,
"ObjectVersionNumber": null,
"RegistryID": null,
"PartyType": null,
"PartyUsgAssignmentId": null,
"PartyUsageCode": null,
"OrganizationName": null,
"SysEffectiveDate": null,
"Comments": null,
"ObjectVersionNumber1": null,
"ObjectVersionNumber2": null,
"CreatedByModule": null,
"Status": null,
"Address1": null,
"Address2": null,
"Country": null,
"CountryName": null,
"StateName": null,
"DunsNumberC": null,
"County": null,
"City": null,
"State": null,
"PostalCode": null,
"PrimaryPhoneNumber": null,
"PrimaryPhoneExtension": null,
"Province": null,
"HqBranchInd": null,
"Address3": null,
"Address4": null,
"IdenAddrLocationId": null,
"IdenAddrPartySiteId": null,
"AddrElementAttribute1": null,
"AddrElementAttribute2": null,
"AddrElementAttribute3": null,
"AddrElementAttribute4": null,
"AddrElementAttribute5": null,
"LocationId": null,
"ObjectVersionNumber3": null,
"AddressStyle": null,
"Building": null,
"FloorNumber": null,
"HouseType": null,
"PostalPlus4Code": null,
"CreatedByModule1": null,
"CreatedByModule2": null,
"AttachmentEntityName": null,
"REST_TEXT_c": "REST TEXT DEFAULT VALUE",
"REST_DATE_c": "2022-03-31",
"REST_DATETIME_c": "2022-04-01T20:20:20+00:00",
"REST_LIST_c": "HIGH",
"links": [
{
"rel": "self",
"href": "https://server/fscmRestApi/resources/version/manufacturers/00040000000EACED00057708000110F09AAFA4F3FFFFFFFFFFFFFFFFFFFFFFFF",
"name": "manufacturers",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://server/fscmRestApi/resources/version/manufacturers/00040000000EACED00057708000110F09AAFA4F3FFFFFFFFFFFFFFFFFFFFFFFF",
"name": "manufacturers",
"kind": "item"
}
]
}