Jump to

• Request
• Response
• Examples

Add one supplier

post

/fscmRestApi/resources/11.13.18.05/buyerPlanningSuppliers/buyerPlanningSuppliers

Add one supplier

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.

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Request Body - application/vnd.oracle.adf.resourceitem+json ()

Root Schema : schema

Match All

Show Source

• object single-post-item
• object type

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

Nested Schema : single-post-item

Type: object

Show Source

• SupplierId: integer (int64)
  Value that uniquely identifies the source supplier.

{
    "type":"object",
    "properties":{
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        }
    }
}

Nested Schema : type

Type: object

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object single-post-item
• object type

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

Nested Schema : single-post-item

Type: object

Show Source

• SupplierId: integer (int64)
  Value that uniquely identifies the source supplier.

{
    "type":"object",
    "properties":{
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        }
    }
}

Nested Schema : type

Type: object

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

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

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

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.

{
    "SupplierId": "2736183"
}

Example Response Body

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

{
    "SupplierId": "2736183",
    "Supplier": "SCC-BetaMedical",
    "SupplierNumber": "1488256822",
    "LastUpdatedDate": "2023-08-04 15:36:46.043",
    "LastUpdatedBy": "COLLABPLANNER",
    "CreationDate": "2023-08-04 15:36:46.043",
    "CreatedBy": "COLLABPLANNER",
    "links": [
        {
            . . .
        }
    ]
}

Back to Top