Jump to

• Request
• Response
• Examples

Create business unit accesses

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/businessUnitAccess

Request

Path Parameters

• draftPurchaseAgreementsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Agreements resource and used to uniquely identify an instance of Draft Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Agreements collection resource in order to navigate to a specific instance of Draft Purchase Agreements to get the hash key.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BillToBU: string
  Title: Bill-to BU

  Maximum Length: 240

  Business unit that processes supplier invoices for the purchase document.
• BilltoBUId: integer (int64)
  Title: Bill to BU ID

  Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
• BillToLocation: string
  Title: Bill-to Location

  Maximum Length: 240

  Value that identifies the bill-to location where the supplier sends the invoice.
• BillToLocationId: integer (int64)
  Value that uniquely identifies the bill-to location.
• EnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the business unit assignment on the agreement is enabled. Values: true or false. No default.
• EntityChangeTypeCode: string
  Maximum Length: 1

  Value that identifies if the row is new or changed.
• OrderLocallyFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value.
• OrganizationAssignmentId: integer (int64)
  Value that uniquely identifies the business unit's access to a purchase agreement.
• PurchasingSite: string
  Title: Purchasing Site

  Maximum Length: 240

  Name of the supplier site for the purchasing business unit.
• PurchasingSiteId: integer (int64)
  Value that uniquely identifies the supplier site for the purchasing operating unit.
• RequisitioningBU: string
  Title: Requisitioning BU

  Maximum Length: 240

  Business unit that creates the requisition.
• RequisitioningBUId: integer (int64)
  Value that uniquely identifies the business unit that requested the goods or services being purchased.
• ShipToLocation: string
  Title: Ship-to Location

  Maximum Length: 240

  Name of the location where the supplier ships the item.
• ShipToLocationCode: string
  Title: Ship-to Location Code

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• ShipToLocationId: integer (int64)
  Value that uniquely identifies the location where the supplier ships the shipment item.

{
    "type":"object",
    "properties":{
        "BillToBU":{
            "title":"Bill-to BU",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that processes supplier invoices for the purchase document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequisitioningBU"
                ]
            }
        },
        "BillToLocation":{
            "title":"Bill-to Location",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the bill-to location where the supplier sends the invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BillToBU"
                ]
            }
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to location.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "BilltoBUId":{
            "title":"Bill to BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the business unit assignment on the agreement is enabled. Values: true or false. No default.",
            "nullable":false,
            "x-queryable":false
        },
        "EntityChangeTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if the row is new or changed.",
            "nullable":true
        },
        "OrderLocallyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit's access to a purchase agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PurchasingSite":{
            "title":"Purchasing Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site for the purchasing business unit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrderLocallyFlag",
                    "RequisitioningBU"
                ]
            }
        },
        "PurchasingSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site for the purchasing operating unit.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that creates the requisition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that requested the goods or services being purchased.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequisitioningBU"
                ]
            }
        },
        "ShipToLocationCode":{
            "title":"Ship-to Location Code",
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the shipment item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

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 : draftPurchaseAgreements-businessUnitAccess-item-response

Type: object

Show Source

• BillToBU: string
  Title: Bill-to BU

  Maximum Length: 240

  Business unit that processes supplier invoices for the purchase document.
• BilltoBUId: integer (int64)
  Title: Bill to BU ID

  Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
• BillToLocation: string
  Title: Bill-to Location

  Maximum Length: 240

  Value that identifies the bill-to location where the supplier sends the invoice.
• BillToLocationId: integer (int64)
  Value that uniquely identifies the bill-to location.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the business unit access on the purchase agreement
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the buyer or the application created the business unit access for the purchase agreement.
• EnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the business unit assignment on the agreement is enabled. Values: true or false. No default.
• EntityChangeTypeCode: string
  Maximum Length: 1

  Value that identifies if the row is new or changed.
• IsOrderLocallyReadOnlyFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the Order Locally setting for the client business unit is read-only. Values: true or false.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the buyer or application last updated the business unit access of a purchase agreement.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the business unit access of a purchase agreement.
• links: array Links
  Title: Links

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

  Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value.
• OrganizationAssignmentId: integer (int64)
  Value that uniquely identifies the business unit's access to a purchase agreement.
• PurchasingSite: string
  Title: Purchasing Site

  Maximum Length: 240

  Name of the supplier site for the purchasing business unit.
• PurchasingSiteId: integer (int64)
  Value that uniquely identifies the supplier site for the purchasing operating unit.
• RequisitioningBU: string
  Title: Requisitioning BU

  Maximum Length: 240

  Business unit that creates the requisition.
• RequisitioningBUId: integer (int64)
  Value that uniquely identifies the business unit that requested the goods or services being purchased.
• ShipToLocation: string
  Title: Ship-to Location

  Maximum Length: 240

  Name of the location where the supplier ships the item.
• ShipToLocationCode: string
  Title: Ship-to Location Code

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• ShipToLocationId: integer (int64)
  Value that uniquely identifies the location where the supplier ships the shipment item.

{
    "type":"object",
    "properties":{
        "BillToBU":{
            "title":"Bill-to BU",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that processes supplier invoices for the purchase document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequisitioningBU"
                ]
            }
        },
        "BillToLocation":{
            "title":"Bill-to Location",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the bill-to location where the supplier sends the invoice.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BillToBU"
                ]
            }
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to location.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "BilltoBUId":{
            "title":"Bill to BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the business unit access on the purchase agreement",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or the application created the business unit access for the purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the business unit assignment on the agreement is enabled. Values: true or false. No default.",
            "nullable":false,
            "x-queryable":false
        },
        "EntityChangeTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if the row is new or changed.",
            "nullable":true,
            "x-queryable":true
        },
        "IsOrderLocallyReadOnlyFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the Order Locally setting for the client business unit is read-only. Values: true or false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the business unit access of a purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the business unit access of a purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderLocallyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit's access to a purchase agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PurchasingSite":{
            "title":"Purchasing Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site for the purchasing business unit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrderLocallyFlag",
                    "RequisitioningBU"
                ]
            }
        },
        "PurchasingSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site for the purchasing operating unit.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that creates the requisition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that requested the goods or services being purchased.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequisitioningBU"
                ]
            }
        },
        "ShipToLocationCode":{
            "title":"Ship-to Location Code",
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the shipment item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "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."
        }
    }
}

Back to Top

Examples

This example describes how to create one one business unit access.

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/draftPurchaseAgreements/draftPurchaseAgreementsUniqID/child/businessUnitAccess"

For example:

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

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

 {

    "RequisitioningBU": "Vision Project Mfg",
    "PurchasingSite": "Philadelphia",
    "ShipToLocation": "P2- Los Angeles",
    "BillToBU": "Vision Project Mfg",
    "BillToLocation": "PM- HQ Location (LA)",
    "EnabledFlag": true
}

Example Response Body

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

{
    "OrganizationAssignmentId": 300100650109829,
    "RequisitioningBUId": 600,
    "RequisitioningBU": "Vision Project Mfg",
    "OrderLocallyFlag": false,
    "PurchasingSiteId": 300100559967535,
    "PurchasingSite": "Philadelphia",
    "ShipToLocationId": 409,
    "ShipToLocationCode": "P2- Los Angeles",
    "ShipToLocation": "P2- Los Angeles",
    "BilltoBUId": 600,
    "BillToBU": "Vision Project Mfg",
    "BillToLocationId": 412,
    "BillToLocation": "PM- HQ Location (LA)",
    "EnabledFlag": true,
    "CreatedBy": "PRC_INTEGRATION_USER",
    "CreationDate": "2026-04-27T04:51:58.679+00:00",
    "LastUpdatedBy": "PRC_INTEGRATION_USER",
    "LastUpdateDate": "2026-04-27T04:51:58.679+00:00",
    "IsOrderLocallyReadOnlyFlag": true,
    "EntityChangeTypeCode": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650135628/child/businessUnitAccess/300100650109829",
            "name": "businessUnitAccess",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650135628/child/businessUnitAccess/300100650109829",
            "name": "businessUnitAccess",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650135628",
            "name": "draftPurchaseAgreements",
            "kind": "item"
        }
    ]
}

Back to Top