Jump to

• Request
• Response
• Examples

Get one supplier

get

/fscmRestApi/resources/11.13.18.05/buyerPlanningSuppliers/buyerPlanningSuppliers/{buyerPlanningSuppliers_Id}

Get one supplier

Request

Path Parameters

• buyerPlanningSuppliers_Id(required): string
  The value of this parameter could be a hash of the key that's used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=CustomerDemandId=

Query Parameters

• dependency(required): 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 are 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(required): 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 are processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields(required): 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 are 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 are considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links(required): 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(required): boolean
  The resource item payload is filtered to contain only data (no links section, for example).

Header Parameters

• 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• 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 : buyerPlanningSuppliers-item-response

Match All

Show Source

• object ItemProperties
• object buyerPlanningSuppliers-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/buyerPlanningSuppliers-item"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

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

Nested Schema : buyerPlanningSuppliers-item

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who added the supplier.
• CreationDate: string
  Title: Creation Date

  Read Only: true

  Date when the user added the supplier.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who performed the most recent update.
• LastUpdatedDate: string
  Title: Last Updated Date

  Read Only: true

  Date when the user most recently updated the supplier.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Name of the source supplier.
• SupplierId: integer (int64)
  Title: Supplier Id

  Value that uniquely identifies the source supplier.
• SupplierNumber: string
  Title: Supplier Number

  Read Only: true

  Maximum Length: 360

  Number that identifies the source supplier.

{
    "type":"object",
    "properties":{
        "SupplierId":{
            "title":"Supplier Id",
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":18
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the source supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":360,
            "type":"string",
            "description":"Number that identifies the source supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdatedDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the user most recently updated the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user added the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who added the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    },
    "x-links":[
        {
            "rel":"self",
            "method":"get",
            "title":"self",
            "href":"/fscmRestApi/scc/buyerPlanningSuppliers/{buyerPlanningSuppliers_Id}"
        }
    ]
}

Relationships

self

Method: get

Path: /fscmRestApi/scc/buyerPlanningSuppliers/{buyerPlanningSuppliers_Id}

Nested Schema : buyerPlanningSuppliers-item-response-allOf[2]

Type: object

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 get one supplier.

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/buyerPlanningSuppliers/buyerPlanningSuppliersId"

Example Response Body

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

{
    "SupplierId": "2736180",
    "Supplier": "SCC-AllMeds",
    "SupplierNumber": "1488256813",
    "LastUpdatedDate": "2023-07-21T10:03:50.111+00:00",
    "LastUpdatedBy": "COLLABPLANNER",
    "CreationDate": "2023-07-21T10:03:50.111+00:00",
    "CreatedBy": "COLLABPLANNER",
    "links": [
        {
            . . .
        }
    ]
}

Back to Top