Jump to

• Request
• Response
• Examples

Create one restriction

post

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/suppliers/{SupplierInvitationId}/child/supplierLineAccessRestrictions

Request

Path Parameters

• SupplierInvitationId(required): integer(int64)
  Value that uniquely identifies the supplier invited to the negotiation.
• supplierNegotiationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations 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

• Line: string
  Title: Line

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineId: number
  Value that uniquely identifies the negotiation line.

{
    "type":"object",
    "properties":{
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the negotiation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the restriction.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the restriction.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the restriction.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the restriction.
• Line: string
  Title: Line

  Maximum Length: 25

  Number that identifies the negotiation line.
• LineDescription: string
  Title: Line Description

  Read Only: true

  Maximum Length: 2500

  Description of the negotiation line.
• LineId: number
  Value that uniquely identifies the negotiation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SupplierInvitationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier invited to the negotiation.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the restriction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Line":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Number that identifies the negotiation line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the restriction.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the restriction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineId":{
            "type":"number",
            "description":"Value that uniquely identifies the negotiation line.",
            "nullable":false,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Line Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierInvitationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier invited to the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the restriction.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 create a restriction.

Example 1 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/supplierNegotiations/supplierNegotiationsUniqID/child/suppliers/SupplierInvitationId/child/supplierLineAccessRestrictions"

Example 1 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 creates.

{
	"Line":2
}

Example 1 Response Body

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

{
	"AuctionHeaderId": 300100195048752,
	"LineId": 3,
	"SupplierInvitationId": 10,
	"Line": "2",
	"LineDescription": "Laptop Battery",
	"CreatedBy": "CLARE.JONES",
	"CreationDate": "2020-05-28T19:03:16+00:00",
	"LastUpdatedBy": "CLARE.JONES",
	"LastUpdateDate": "2020-05-28T19:03:16.068+00:00",
	"links": [...]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to create multiple line access restrictions for a supplier.

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

Example 2 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 creates.

Path: /supplierNegotiations/{AuctionHeaderId}/child/suppliers/{SupplierInvitationId}/child/supplierLineAccessRestrictions
{
	"parts": [
	{
		"id": "part1",
		"path": "/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"Line": "1"
		}
	},
	{
		"id": "part2",
		"path": "/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"Line": "3"
		}
	}
	]
}

Example 2 Response Body

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

{
	"parts": [
	{
		"id": "part1",
		"path": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"AuctionHeaderId": 300100194925269,
			"LineId": 1,
			"SupplierInvitationId": 30,
			"Line": "1",
			"LineDescription": "UHD 4K Smart LED TV",
			"CreatedBy": "CLARE.JONES",
			"CreationDate": "2020-05-22T11:51:47+00:00",
			"LastUpdatedBy": "CLARE.JONES",
			"LastUpdateDate": "2020-05-22T11:51:47.188+00:00",
			"links": [...]
		}
	},
	{
		"id": "part2",
		"path": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100194925269/child/suppliers/30/child/supplierLineAccessRestrictions",
		"operation": "create",
		"payload": {
			"AuctionHeaderId": 300100194925269,
			"LineId": 2,
			"SupplierInvitationId": 30,
			"Line": "3",
			"LineDescription": "Plain Item",
			"CreatedBy": "CLARE.JONES",
			"CreationDate": "2020-05-22T11:51:47.172+00:00",
			"LastUpdatedBy": "CLARE.JONES",
			"LastUpdateDate": "2020-05-22T11:51:47.188+00:00",
			"links": [...]
		}
	}
	]
}

Back to Top