Get one manufacturer

get

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

Request

Path Parameters
  • 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.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : manufacturers-item-response
Type: object
Show Source
  • Title: Address Line 1
    Maximum Length: 240
    First line in the address of the manufacturer.
  • Title: Address Line 2
    Maximum Length: 240
    Second line in the address of the manufacturer.
  • Title: Address Line 3
    Maximum Length: 240
    Third line in the address of the manufacturer.
  • Title: Address Line 4
    Maximum Length: 240
    Fourth line in the address of the manufacturer.
  • Title: Additional Address Element 1
    Maximum Length: 150
    Address one element used in flexible address formats.
  • Title: Additional Address Element 2
    Maximum Length: 150
    Address two element used in flexible address formats.
  • Title: Additional Address Element 3
    Maximum Length: 150
    Address three element used in flexible address formats.
  • Title: Additional Address Element 4
    Maximum Length: 150
    Address four element used in flexible address formats.
  • Title: Additional Address Element 5
    Maximum Length: 150
    Address five element used in flexible address formats.
  • 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.
  • Title: Building
    Maximum Length: 240
    Building name or number of an address.
  • Title: City
    Maximum Length: 60
    City of the manufacturer.
  • Title: Manufacturer Description
    Maximum Length: 2000
    Description of the manufacturer.
  • Title: Country
    Maximum Length: 2
    Country of the manufacturer.
  • Title: Country
    Name of the country.
  • Title: County
    Maximum Length: 60
    County of the manufacturer.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the manufacturer.
  • Title: Creation Date
    Read Only: true
    Date when the manufacturer was created.
  • Title: D-U-N-S Number
    Maximum Length: 30
    Unique nine-character number used to identify the manufacturer.
  • Title: Floor
    Maximum Length: 40
    Floor number of an address, or of a building when the building number is provided.
  • 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.
  • 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.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    Date when the manufacturer was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the manufacturer.
  • Links
  • Value that uniquely identifies the manufacturer.
  • Title: Manufacturer
    Maximum Length: 360
    Name of the manufacturer.
  • Title: Party Type
    Maximum Length: 30
    Type of party of the manufacturer.
  • Title: Postal Code
    Maximum Length: 60
    Postal code of the manufacturer.
  • Title: Postal Code Extension
    Maximum Length: 20
    Four-digit extension of the United States postal ZIP code in the address.
  • Maximum Length: 20
    Primary phone extension of the manufacturer.
  • Maximum Length: 40
    Primary phone number of the manufacturer.
  • Title: Province
    Maximum Length: 60
    Province of the manufacturer.
  • Title: Registry ID
    Maximum Length: 30
    Value that uniquely identifies the manufacturer by registry ID.
  • Title: State
    Maximum Length: 60
    State of the address.
  • Title: State
    Name of the state.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    Status of the manufacturer.
Back to Top

Examples

This example describes how to get one manufacturer.

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

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/manufacturers?finder=PrimaryKey;ManufacturerId=300100550096514"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "AttributeCategory": null,
            "CorpCurrencyCode": null,
            "CreatedBy": "CREATE_MFR",
            "CreationDate": "2022-04-04T17:39:37+00:00",
            "CurcyConvRateType": null,
            "CurrencyCode": null,
            "IsActiveFlag": null,
            "IsPrivateFlag": null,
            "LastUpdateDate": "2022-04-04T17:39:39.230+00:00",
            "LastUpdateLogin": "DB7D181E22D87472E0531929F80A2EB9",
            "LastUpdatedBy": "CREATE_MFR",
            "ManufacturerId": 300100550096514,
            "ObjectVersionNumber": 2,
            "RegistryID": "CDRM_938227",
            "PartyType": "ORGANIZATION",
            "PartyUsgAssignmentId": 300100550096515,
            "PartyUsageCode": "MANUFACTURER",
            "OrganizationName": "Test REST MANAGE_MFR",
            "SysEffectiveDate": null,
            "Comments": null,
            "ObjectVersionNumber1": 1,
            "ObjectVersionNumber2": 2,
            "CreatedByModule": "EGO",
            "Status": "A",
            "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": "EGO",
            "CreatedByModule2": null,
            "AttachmentEntityName": "ACA_MANUFACTURER",
            "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/00040000000EACED00057708000110F09AAF76820000000EACED00057708000110F09AAF76820000000EACED00057708000110F09AAF76830000000EACED00057708000110F09AAF7682",
                    "name": "manufacturers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000047704000000047372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0004000000017371007E00040000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/manufacturers/00040000000EACED00057708000110F09AAF76820000000EACED00057708000110F09AAF76820000000EACED00057708000110F09AAF76830000000EACED00057708000110F09AAF7682",
                    "name": "manufacturers",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 499,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/manufacturers",
            "name": "manufacturers",
            "kind": "collection"
        }
    ]
}
Back to Top