Jump to

• Request
• Response
• Examples

Update a manufacturer

patch

/fscmRestApi/resources/11.13.18.05/manufacturers/{manufacturersUniqID}

Request

Path Parameters

• manufacturersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Manufacturers resource and used to uniquely identify an instance of Manufacturers. The client should not generate the hash key value. Instead, the client should query on the Manufacturers collection resource in order to navigate to a specific instance of Manufacturers to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  First line in the address of the manufacturer.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  Second line in the address of the manufacturer.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  Third line in the address of the manufacturer.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth line in the address of the manufacturer.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

  Address one element used in flexible address formats.
• AddressElementAttribute2: string
  Title: Additional Address Element 2

  Maximum Length: 150

  Address two element used in flexible address formats.
• AddressElementAttribute3: string
  Title: Additional Address Element 3

  Maximum Length: 150

  Address three element used in flexible address formats.
• AddressElementAttribute4: string
  Title: Additional Address Element 4

  Maximum Length: 150

  Address four element used in flexible address formats.
• AddressElementAttribute5: string
  Title: Additional Address Element 5

  Maximum Length: 150

  Address five element used in flexible address formats.
• AddressStyle: string
  Maximum Length: 30

  Used 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.
• Building: string
  Title: Building

  Maximum Length: 240

  Building name or number of an address.
• City: string
  Title: City

  Maximum Length: 60

  City of the manufacturer.
• Comments: string
  Title: Manufacturer Description

  Maximum Length: 2000

  Description of the manufacturer.
• Country: string
  Title: Country

  Maximum Length: 2

  Country of the manufacturer.
• CountryName: string
  Title: Country

  Name of the country.
• County: string
  Title: County

  Maximum Length: 60

  County of the manufacturer.
• DUNSNumber: string
  Title: D-U-N-S Number

  Maximum Length: 30

  Unique nine-character number used to identify the manufacturer.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  Floor number of an address, or of a building when the building number is provided.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  Type 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.
• IsActiveFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the manufacturer is active. If false, then the manufacturer is inactive. The default value is true.
• IsPrivateFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the manufacturer is private. If false, then the manufacturer is public. The default value is false.
• ManufacturerId: integer (int64)
  Value that uniquely identifies the manufacturer.
• OrganizationName: string
  Title: Manufacturer

  Maximum Length: 360

  Name of the manufacturer.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  Postal code of the manufacturer.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  Four-digit extension of the United States postal ZIP code in the address.
• PrimaryPhoneExtension: string
  Maximum Length: 20

  Primary phone extension of the manufacturer.
• PrimaryPhoneNumber: string
  Maximum Length: 40

  Primary phone number of the manufacturer.
• Province: string
  Title: Province

  Maximum Length: 60

  Province of the manufacturer.
• RegistryId: string
  Title: Registry ID

  Maximum Length: 30

  Value that uniquely identifies the manufacturer by registry ID.
• State: string
  Title: State

  Maximum Length: 60

  State of the address.
• StateName: string
  Title: State

  Name of the state.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Status of the manufacturer.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Manufacturer",
            "maxLength":360,
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"Building name or number of an address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"Floor number of an address, or of a building when the building number is provided.",
            "nullable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"Address four element used in flexible address formats.",
            "nullable":true
        },
        "CountryName":{
            "title":"Country",
            "type":"string",
            "description":"Name of the country.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"Address five element used in flexible address formats.",
            "nullable":true
        },
        "DUNSNumber":{
            "title":"D-U-N-S Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique nine-character number used to identify the manufacturer.",
            "nullable":true
        },
        "ManufacturerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StateName":{
            "title":"State",
            "type":"string",
            "description":"Name of the state.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "PrimaryPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Primary phone extension of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            }
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"Type 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.",
            "nullable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"Fourth line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressStyle":{
            "maxLength":30,
            "type":"string",
            "description":"Used 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.",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"Status of the manufacturer.",
            "nullable":false,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "title":"Manufacturer Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Second line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"Third line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"First line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"Four-digit extension of the United States postal ZIP code in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "IsPrivateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the manufacturer is private. If false, then the manufacturer is public. The default value is false.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "PrimaryPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Primary phone number of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            }
        },
        "IsActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the manufacturer is active. If false, then the manufacturer is inactive. The default value is true.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country of the manufacturer.",
            "nullable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"Address one element used in flexible address formats.",
            "nullable":true
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the manufacturer by registry ID.",
            "nullable":false
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"Address two element used in flexible address formats.",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"Address three element used in flexible address formats.",
            "nullable":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(required):
  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(required):
  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 : manufacturers-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  First line in the address of the manufacturer.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  Second line in the address of the manufacturer.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  Third line in the address of the manufacturer.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth line in the address of the manufacturer.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

  Address one element used in flexible address formats.
• AddressElementAttribute2: string
  Title: Additional Address Element 2

  Maximum Length: 150

  Address two element used in flexible address formats.
• AddressElementAttribute3: string
  Title: Additional Address Element 3

  Maximum Length: 150

  Address three element used in flexible address formats.
• AddressElementAttribute4: string
  Title: Additional Address Element 4

  Maximum Length: 150

  Address four element used in flexible address formats.
• AddressElementAttribute5: string
  Title: Additional Address Element 5

  Maximum Length: 150

  Address five element used in flexible address formats.
• AddressStyle: string
  Maximum Length: 30

  Used 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.
• Building: string
  Title: Building

  Maximum Length: 240

  Building name or number of an address.
• City: string
  Title: City

  Maximum Length: 60

  City of the manufacturer.
• Comments: string
  Title: Manufacturer Description

  Maximum Length: 2000

  Description of the manufacturer.
• Country: string
  Title: Country

  Maximum Length: 2

  Country of the manufacturer.
• CountryName: string
  Title: Country

  Name of the country.
• County: string
  Title: County

  Maximum Length: 60

  County of the manufacturer.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date when the manufacturer was created.
• DUNSNumber: string
  Title: D-U-N-S Number

  Maximum Length: 30

  Unique nine-character number used to identify the manufacturer.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  Floor number of an address, or of a building when the building number is provided.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  Type 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.
• IsActiveFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the manufacturer is active. If false, then the manufacturer is inactive. The default value is true.
• IsPrivateFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the manufacturer is private. If false, then the manufacturer is public. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the manufacturer was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the manufacturer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerId: integer (int64)
  Value that uniquely identifies the manufacturer.
• OrganizationName: string
  Title: Manufacturer

  Maximum Length: 360

  Name of the manufacturer.
• PartyType: string
  Title: Party Type

  Maximum Length: 30

  Type of party of the manufacturer.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  Postal code of the manufacturer.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  Four-digit extension of the United States postal ZIP code in the address.
• PrimaryPhoneExtension: string
  Maximum Length: 20

  Primary phone extension of the manufacturer.
• PrimaryPhoneNumber: string
  Maximum Length: 40

  Primary phone number of the manufacturer.
• Province: string
  Title: Province

  Maximum Length: 60

  Province of the manufacturer.
• RegistryId: string
  Title: Registry ID

  Maximum Length: 30

  Value that uniquely identifies the manufacturer by registry ID.
• State: string
  Title: State

  Maximum Length: 60

  State of the address.
• StateName: string
  Title: State

  Name of the state.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Status of the manufacturer.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Manufacturer",
            "maxLength":360,
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"Building name or number of an address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the manufacturer was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"Floor number of an address, or of a building when the building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"Address four element used in flexible address formats.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country",
            "type":"string",
            "description":"Name of the country.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"Address five element used in flexible address formats.",
            "nullable":true,
            "x-queryable":true
        },
        "DUNSNumber":{
            "title":"D-U-N-S Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique nine-character number used to identify the manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "ManufacturerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StateName":{
            "title":"State",
            "type":"string",
            "description":"Name of the state.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"County of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "PrimaryPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Primary phone extension of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"Type 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.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"Fourth line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of party of the manufacturer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressStyle":{
            "maxLength":30,
            "type":"string",
            "description":"Used 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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the manufacturer.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"Status of the manufacturer.",
            "nullable":false,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the manufacturer.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Manufacturer Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Second line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"Third line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"First line in the address of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"City of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Province of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"Four-digit extension of the United States postal ZIP code in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "IsPrivateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the manufacturer is private. If false, then the manufacturer is public. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"State of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Primary phone number of the manufacturer.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "IsActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the manufacturer is active. If false, then the manufacturer is inactive. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Country of the manufacturer.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"Address one element used in flexible address formats.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the manufacturer by registry ID.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"Address two element used in flexible address formats.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"Address three element used in flexible address formats.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the manufacturer was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top

Examples

This example describes how to update a manufacturer.

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/manufacturers/manufacturersUniqID"

For example:

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

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.

{
    "Status": "I"
}

Example Response Body

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

{
    "OrganizationName": "TESTINGMFR",
    "Comments": "Delete",
    "RegistryId": "CDRM_943583",
    "DUNSNumber": null,
    "Status": "I",
    "CreatedBy": "PLM_AUTO",
    "CreationDate": "2022-06-30T20:14:08.561+00:00",
    "IsActiveFlag": null,
    "IsPrivateFlag": null,
    "LastUpdatedBy": "PLM_AUTO",
    "LastUpdateDate": "2022-06-30T20:14:34.768+00:00",
    "ManufacturerId": 300100674741557,
    "PartyType": "ORGANIZATION",
    "Address1": null,
    "Address2": null,
    "Country": null,
    "CountryName": null,
    "StateName": null,
    "County": null,
    "City": null,
    "State": null,
    "PostalCode": null,
    "PrimaryPhoneNumber": null,
    "PrimaryPhoneExtension": null,
    "Province": null,
    "Address3": null,
    "Address4": null,
    "AddressElementAttribute1": null,
    "AddressElementAttribute2": null,
    "AddressElementAttribute3": null,
    "AddressElementAttribute4": null,
    "AddressElementAttribute5": null,
    "AddressStyle": null,
    "Building": null,
    "FloorNumber": null,
    "HouseType": null,
    "PostalPlus4Code": null,
    "Custom_Text_c": "Default Value",
    "Custom_Date_c": "2022-06-23",
    "Custom_List_c": "HIGH",
    "Custom_Idea_DCL_Id_c": null,
    "Custom_Idea_DCL_c": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/11.13.18.05/manufacturers/00050000000EACED00057708000110F0A21D65350000000EACED00057708000110F0A21D65350000000EACED00057708000110F0A21D65360000000EACED00057708000110F0A21D6535FFFFFFFF",
            "name": "manufacturers",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000057704000000057372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0004000000017371007E00040000000271007E000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/manufacturers/00050000000EACED00057708000110F0A21D65350000000EACED00057708000110F0A21D65350000000EACED00057708000110F0A21D65360000000EACED00057708000110F0A21D6535FFFFFFFF",
            "name": "manufacturers",
            "kind": "item"
        }
    ]
}

Back to Top