REST API for Oracle Fusion Cloud Procurement

Create one buyer assignment rule

post

/fscmRestApi/resources/11.13.18.05/purchasingBuyerAssignmentRules

Request

Header Parameters

Effective-Of: string

This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
Metadata-Context: string

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

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

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

Root Schema : schema

Type: object

Show Source

BuyerId(required): integer (int64)

Title: Buyer

Value that uniquely identifies the buyer.
ChartOfAccountsId: integer (int64)

Default Value: -1

Value that uniquely identifies the buyer assignment rule.
CommodityId: integer (int64)

Default Value: -1

Value that uniquely identifies the commodity.
CostCenter: string

Maximum Length: 150

Segment of the chart of accounts.
costCenterKeyFlexfield: array costCenterKeyFlexfield
DeliverToOrganizationId: integer (int64)

Value that uniquely identifies the deliver-to organization.
ExceedsLineAmount: number

Represents the line amount.
NonCatalogFlag: boolean

Maximum Length: 1

Indicates whether the rule is a noncatalog request. Valid values are Y, N, and null.
ProcurementBusinessUnitId(required): integer (int64)

Title: Procurement BU

Value that uniquely identifies the procurement business unit.
ProjectId: integer (int64)

Value that uniquely identifies the project.
RequisitioningBusinessUnitId: integer (int64)

Default Value: -1

Value that uniquely identifies the requisitioning business unit.
RuleId: integer (int64)

Value that uniquely identifies the buyer assignment rule.
RuleSequenceNumber(required): number

Title: Rule Sequence

Unique number to identify the rule being applied during the assignment process.
RuleSetCode: string

Maximum Length: 120

Abbreviation that identifies the rule set.
SupplierId: integer (int64)

Value that uniquely identifies the supplier.

{
    "required":[
        "BuyerId",
        "ProcurementBusinessUnitId",
        "RuleSequenceNumber"
    ],
    "type":"object",
    "properties":{
        "BuyerId":{
            "title":"Buyer",
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChartOfAccountsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer assignment rule.",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "FND_ACFF_FlexfieldCode":"GL#",
                "precision":18,
                "FND_ACFF_ApplicationID":"101",
                "FND_ACFF_StructureLookupRequired":"false",
                "FND_ACFF_ModelID":"KFF_GL_GL_23_PO_5FBAR_5FCOST_5FCENTER_PO_5FBUYER_5FASSIGNMENT_5FRULES",
                "FND_ACFF_ApplicationShortName":"GL"
            }
        },
        "CommodityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the commodity.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "CostCenter":{
            "maxLength":150,
            "type":"string",
            "description":"Segment of the chart of accounts.",
            "nullable":true
        },
        "DeliverToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the deliver-to organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExceedsLineAmount":{
            "type":"number",
            "description":"Represents the line amount.",
            "nullable":true
        },
        "NonCatalogFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is a noncatalog request. Valid values are Y, N, and null.",
            "nullable":true
        },
        "ProcurementBusinessUnitId":{
            "title":"Procurement BU",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RequisitioningBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer assignment rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleSequenceNumber":{
            "title":"Rule Sequence",
            "type":"number",
            "description":"Unique number to identify the rule being applied during the assignment process.",
            "nullable":false
        },
        "RuleSetCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the rule set.",
            "nullable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "costCenterKeyFlexfield":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchasingBuyerAssignmentRules-costCenterKeyFlexfield-item-post-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : costCenterKeyFlexfield

Type: array

Show Source

Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/purchasingBuyerAssignmentRules-costCenterKeyFlexfield-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

_GL_5FGL_23_StructureInstanceNumber: integer (int64)

Default Value: -1
RuleId: integer (int64)

{
    "type":"object",
    "properties":{
        "RuleId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "_GL_5FGL_23_StructureInstanceNumber":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_IsStructureID":"true",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_StructureLookupRequired":"false",
                "FND_ACFF_PreferredDisplayType":"DEFAULT"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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.

Root Schema : purchasingBuyerAssignmentRules-item-response

Type: object

Show Source

Buyer: string

Title: Name

Read Only: true

Maximum Length: 240

Name of the buyer.
BuyerId: integer (int64)

Title: Buyer

Value that uniquely identifies the buyer.
ChartOfAccountsId: integer (int64)

Default Value: -1

Value that uniquely identifies the buyer assignment rule.
Commodity: string

Read Only: true

Maximum Length: 255

Name of the commodity.
CommodityId: integer (int64)

Default Value: -1

Value that uniquely identifies the commodity.
CostCenter: string

Maximum Length: 150

Segment of the chart of accounts.
costCenterKeyFlexfield: array costCenterKeyFlexfield
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the buyer assignment rule.
Currency: string

Read Only: true

Maximum Length: 15

Currency of the buyer assignment rule.
DeliverToOrganization: string

Read Only: true

Maximum Length: 240

Name of the deliver-to organization.
DeliverToOrganizationId: integer (int64)

Value that uniquely identifies the deliver-to organization.
ExceedsLineAmount: number

Represents the line amount.
LastUpdateDate: string (date-time)

Read Only: true

User who most recently updated the buyer assignment rule.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

Date and time when user most recently updated the buyer assignment rule.
links: array Links

Title: Links

The link relations associated with the resource instance.
NonCatalogFlag: boolean

Maximum Length: 1

Indicates whether the rule is a noncatalog request. Valid values are Y, N, and null.
ProcurementBusinessUnit: string

Title: Name

Read Only: true

Maximum Length: 240

Name of the procurement business unit.
ProcurementBusinessUnitId: integer (int64)

Title: Procurement BU

Value that uniquely identifies the procurement business unit.
Project: string

Title: Project Number

Read Only: true

Maximum Length: 25

Name of the project.
ProjectId: integer (int64)

Value that uniquely identifies the project.
RequisitioningBusinessUnit: string

Title: Name

Read Only: true

Maximum Length: 240

Name of the requisitioning business unit.
RequisitioningBusinessUnitId: integer (int64)

Default Value: -1

Value that uniquely identifies the requisitioning business unit.
RuleId: integer (int64)

Value that uniquely identifies the buyer assignment rule.
RuleSequenceNumber: number

Title: Rule Sequence

Unique number to identify the rule being applied during the assignment process.
RuleSet: string

Title: Meaning

Read Only: true

Maximum Length: 80

Description of the rule set.
RuleSetCode: string

Maximum Length: 120

Abbreviation that identifies the rule set.
Supplier: string

Read Only: true

Maximum Length: 360

Name of the supplier.
SupplierId: integer (int64)

Value that uniquely identifies the supplier.

{
    "type":"object",
    "properties":{
        "Buyer":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the buyer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyerId":{
            "title":"Buyer",
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChartOfAccountsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer assignment rule.",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "FND_ACFF_FlexfieldCode":"GL#",
                "precision":18,
                "FND_ACFF_ApplicationID":"101",
                "FND_ACFF_StructureLookupRequired":"false",
                "FND_ACFF_ModelID":"KFF_GL_GL_23_PO_5FBAR_5FCOST_5FCENTER_PO_5FBUYER_5FASSIGNMENT_5FRULES",
                "FND_ACFF_ApplicationShortName":"GL"
            },
            "x-queryable":true
        },
        "Commodity":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the commodity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommodityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the commodity.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostCenter":{
            "maxLength":150,
            "type":"string",
            "description":"Segment of the chart of accounts.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the buyer assignment rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"Currency of the buyer assignment rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliverToOrganization":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the deliver-to organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliverToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the deliver-to organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceedsLineAmount":{
            "type":"number",
            "description":"Represents the line amount.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the buyer assignment rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date and time when user most recently updated the buyer assignment rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NonCatalogFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is a noncatalog request. Valid values are Y, N, and null.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBusinessUnit":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBusinessUnitId":{
            "title":"Procurement BU",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Project":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"Name of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the project.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitioningBusinessUnit":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the requisitioning business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit.",
            "format":"int64",
            "nullable":false,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer assignment rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleSequenceNumber":{
            "title":"Rule Sequence",
            "type":"number",
            "description":"Unique number to identify the rule being applied during the assignment process.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleSet":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleSetCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the rule set.",
            "nullable":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "costCenterKeyFlexfield":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchasingBuyerAssignmentRules-costCenterKeyFlexfield-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : costCenterKeyFlexfield

Type: array

Show Source

Array of: object purchasingBuyerAssignmentRules-costCenterKeyFlexfield-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/purchasingBuyerAssignmentRules-costCenterKeyFlexfield-item-response"
    },
    "x-cardinality":"1"
}

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 : purchasingBuyerAssignmentRules-costCenterKeyFlexfield-item-response

Type: object

Show Source

_GL_5FGL_23_StructureInstanceNumber: integer (int64)

Default Value: -1
links: array Links

Title: Links

The link relations associated with the resource instance.
RuleId: integer (int64)

{
    "type":"object",
    "properties":{
        "RuleId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "_GL_5FGL_23_StructureInstanceNumber":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "FND_ACFF_IsStructureID":"true",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_StructureLookupRequired":"false",
                "FND_ACFF_PreferredDisplayType":"DEFAULT"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Links

costCenterKeyFlexfield

Operation: /fscmRestApi/resources/11.13.18.05/purchasingBuyerAssignmentRules/{purchasingBuyerAssignmentRulesUniqID}/child/costCenterKeyFlexfield

Parameters:

purchasingBuyerAssignmentRulesUniqID: $request.path.purchasingBuyerAssignmentRulesUniqID