Jump to

• Request
• Response

Create selection criteria

post

/fscmRestApi/resources/11.13.18.05/externalPurchasePricesSelectionCriteria

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• LowestPriceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the external purchase price with the lowest value is selected. If false, then the value of the price isn't considered for the selection. The default value is false.
• PartyType: string
  Title: Meaning

  Maximum Length: 80

  Type of party of the contract for the external purchase prices. This value can be a manufacturer or a distributor.
• PartyTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of party of the contract for the external purchase prices.
• RequisitioningBUGroupId: integer (int64)
  Value that uniquely identifies a group of requisitioning business units.
• RequisitioningBUName: string
  Maximum Length: 700

  Name of the requisitioning business unit for which the selection criteria is defined.
• SelectionId: integer (int64)
  Value that uniquely identifies the external purchase prices selection criteria.
• SourceContractType: string
  Title: Meaning

  Maximum Length: 80

  Type of source of the contract for the external purchase prices. This value can be a local or a group purchasing organization.
• SourceContractTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of source of the contract for the external purchase prices.

{
    "type":"object",
    "properties":{
        "RequisitioningBUGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies a group of requisitioning business units.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "RequisitioningBUName"
                ]
            }
        },
        "LowestPriceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external purchase price with the lowest value is selected. If false, then the value of the price isn't considered for the selection. The default value is false.",
            "nullable":true
        },
        "PartyTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of party of the contract for the external purchase prices.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartyType"
                ]
            }
        },
        "SourceContractType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of source of the contract for the external purchase prices. This value can be a local or a group purchasing organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequisitioningBUName":{
            "maxLength":"700",
            "type":"string",
            "description":"Name of the requisitioning business unit for which the selection criteria is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceContractTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of source of the contract for the external purchase prices.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceContractType"
                ]
            }
        },
        "SelectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external purchase prices selection criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PartyType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of party of the contract for the external purchase prices. This value can be a manufacturer or a distributor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : externalPurchasePricesSelectionCriteria-item-response

Type: object

Show Source

• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the selection criteria record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LowestPriceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the external purchase price with the lowest value is selected. If false, then the value of the price isn't considered for the selection. The default value is false.
• PartyType: string
  Title: Meaning

  Maximum Length: 80

  Type of party of the contract for the external purchase prices. This value can be a manufacturer or a distributor.
• PartyTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of party of the contract for the external purchase prices.
• RequisitioningBUGroupId: integer (int64)
  Value that uniquely identifies a group of requisitioning business units.
• RequisitioningBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requisitioning business unit for which the selection criteria is defined.
• RequisitioningBUName: string
  Maximum Length: 700

  Name of the requisitioning business unit for which the selection criteria is defined.
• SelectionId: integer (int64)
  Value that uniquely identifies the external purchase prices selection criteria.
• SourceContractType: string
  Title: Meaning

  Maximum Length: 80

  Type of source of the contract for the external purchase prices. This value can be a local or a group purchasing organization.
• SourceContractTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of source of the contract for the external purchase prices.

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit for which the selection criteria is defined.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequisitioningBUGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies a group of requisitioning business units.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "RequisitioningBUName"
                ]
            },
            "x-queryable":true
        },
        "LowestPriceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external purchase price with the lowest value is selected. If false, then the value of the price isn't considered for the selection. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of party of the contract for the external purchase prices.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartyType"
                ]
            },
            "x-queryable":true
        },
        "SourceContractType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of source of the contract for the external purchase prices. This value can be a local or a group purchasing organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitioningBUName":{
            "maxLength":"700",
            "type":"string",
            "description":"Name of the requisitioning business unit for which the selection criteria is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceContractTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of source of the contract for the external purchase prices.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceContractType"
                ]
            },
            "x-queryable":true
        },
        "SelectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external purchase prices selection criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of party of the contract for the external purchase prices. This value can be a manufacturer or a distributor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the selection criteria record.",
            "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