REST API for Oracle Fusion Cloud Financials

Create a SAM trading partner business unit assignment record

post

/fscmRestApi/resources/11.13.18.05/fedSAMVendorBusinessUnits

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

Root Schema : schema

Type: object

Show Source

BusinessUnit: string

Title: Business Unit

Maximum Length: 80

Business unit of the SAM trading partner business unit assignment record.
EFTIndicator: string

Title: EFT Indicator

Maximum Length: 255

EFT indicator of the SAM trading partner business unit assignment record.
MainAddressSite: string

Title: Main Address Site

Maximum Length: 255

Main address site of the SAM trading partner business unit assignment record.
SamBUAssignmentId: integer (int64)

Title: Sam BU Assignment Id

Unique identifier of the SAM trading partner business unit assignment record.
Supplier: string

Title: Supplier

Maximum Length: 255

Supplier of the SAM trading partner business unit assignment record.
SupplierSite: string

Title: Supplier Site

Maximum Length: 255

Supplier site of the SAM trading partner business unit assignment record.
UniqueEntityIdentifier: string

Title: Unique Entity Identifier

Maximum Length: 255

Unique entity identifier of the SAM trading partner business unit assignment record.

{
    "type":"object",
    "properties":{
        "UniqueEntityIdentifier":{
            "title":"Unique Entity Identifier",
            "maxLength":255,
            "type":"string",
            "description":"Unique entity identifier of the SAM trading partner business unit assignment record.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SamTradingPartnerId"
                ]
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":80,
            "type":"string",
            "description":"Business unit of the SAM trading partner business unit assignment record.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "BusinessUnitId",
                    "Name"
                ]
            }
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":255,
            "type":"string",
            "description":"Supplier site of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PrcBuId"
                ]
            }
        },
        "SamBUAssignmentId":{
            "title":"Sam BU Assignment Id",
            "type":"integer",
            "description":"Unique identifier of the SAM trading partner business unit assignment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EFTIndicator":{
            "title":"EFT Indicator",
            "maxLength":255,
            "type":"string",
            "description":"EFT indicator of the SAM trading partner business unit assignment record.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EntityEFTIndicator"
                ]
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":255,
            "type":"string",
            "description":"Supplier of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId",
                    "PartyName"
                ]
            }
        },
        "MainAddressSite":{
            "title":"Main Address Site",
            "maxLength":255,
            "type":"string",
            "description":"Main address site of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

Type: object

Show Source

BusinessUnit: string

Title: Business Unit

Maximum Length: 80

Business unit of the SAM trading partner business unit assignment record.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

User who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date when the record was created.
EFTIndicator: string

Title: EFT Indicator

Maximum Length: 255

EFT indicator of the SAM trading partner business unit assignment record.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

User who last updated the record.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The session login associated to the user who last updated the record.
LegalBusinessName: string

Title: Legal Business Name

Read Only: true

Maximum Length: 120

Legal business name of the SAM trading partner business unit assignment record.
links: array Links

Title: Links

The link relations associated with the resource instance.
Location: string

Title: Location

Read Only: true

Maximum Length: 60

Location of the business unit associated with the SAM trading partner business unit assignment record.
MainAddressSite: string

Title: Main Address Site

Maximum Length: 255

Main address site of the SAM trading partner business unit assignment record.
ProcessStatus: string

Title: Process Status

Read Only: true

Maximum Length: 255

Process status for supplier association of the SAM trading partner details record.
SamBUAssignmentId: integer (int64)

Title: Sam BU Assignment Id

Unique identifier of the SAM trading partner business unit assignment record.
Status: string

Title: Registration Status

Read Only: true

Maximum Length: 255

Registration status of the SAM trading partner business unit assignment record.
Supplier: string

Title: Supplier

Maximum Length: 255

Supplier of the SAM trading partner business unit assignment record.
SupplierSite: string

Title: Supplier Site

Maximum Length: 255

Supplier site of the SAM trading partner business unit assignment record.
UniqueEntityIdentifier: string

Title: Unique Entity Identifier

Maximum Length: 255

Unique entity identifier of the SAM trading partner business unit assignment record.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Registration Status",
            "maxLength":255,
            "type":"string",
            "description":"Registration status of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LookupCode",
                    "LookupType",
                    "Meaning"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalBusinessName":{
            "title":"Legal Business Name",
            "maxLength":120,
            "type":"string",
            "description":"Legal business name of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStatus":{
            "title":"Process Status",
            "maxLength":255,
            "type":"string",
            "description":"Process status for supplier association of the SAM trading partner details record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode2",
                    "LookupType2",
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "MainAddressSite":{
            "title":"Main Address Site",
            "maxLength":255,
            "type":"string",
            "description":"Main address site of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UniqueEntityIdentifier":{
            "title":"Unique Entity Identifier",
            "maxLength":255,
            "type":"string",
            "description":"Unique entity identifier of the SAM trading partner business unit assignment record.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SamTradingPartnerId"
                ]
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":80,
            "type":"string",
            "description":"Business unit of the SAM trading partner business unit assignment record.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "BusinessUnitId",
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":255,
            "type":"string",
            "description":"Supplier site of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PrcBuId"
                ]
            }
        },
        "SamBUAssignmentId":{
            "title":"Sam BU Assignment Id",
            "type":"integer",
            "description":"Unique identifier of the SAM trading partner business unit assignment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EFTIndicator":{
            "title":"EFT Indicator",
            "maxLength":255,
            "type":"string",
            "description":"EFT indicator of the SAM trading partner business unit assignment record.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "EntityEFTIndicator"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":255,
            "type":"string",
            "description":"Supplier of the SAM trading partner business unit assignment record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId",
                    "PartyName"
                ]
            }
        },
        "Location":{
            "title":"Location",
            "maxLength":60,
            "type":"string",
            "description":"Location of the business unit associated with the SAM trading partner business unit assignment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "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."
        }
    }
}

Examples

You can use the POST action in the Federal SAM Trading Partner Business Units REST API to create Federal SAM Trading Partner Business Units.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSAMVendorBusinessUnits

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "UniqueEntityIdentifier": "ABCTEST00002",
    "EFTIndicator": "",
    "BusinessUnit": "FederalBusinessUnit",
    "MainAddressSite": "No"
}

Example Response Body

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

{
    "SamBUAssignmentId": 300100564970239,
    "UniqueEntityIdentifier": "ABCTEST00002",
    "LegalBusinessName": "DRUG ENFORCEMENT ADMINISTRATION",
    "Supplier": null,
    "EFTIndicator": null,
    "BusinessUnit": "FederalBusinessUnit",
    "Location": "FEDERAL",
    "CreatedBy": "FEDBUYER",
    "CreationDate": "2022-12-02T07:11:47+00:00",
    "LastUpdateDate": "2022-12-02T07:11:47.305+00:00",
    "LastUpdateLogin": "EE8E9913721A4377E05309B2F20A1D2F",
    "LastUpdatedBy": "FEDBUYER",
    "SupplierSite": null,
    "Status": "Active",
    "MainAddressSite": "No",
    "links": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc325-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedSAMVendorBusinessUnits/300100564970239",
            "name": "fedSAMVendorBusinessUnits",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://fuscdrmsmc325-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.18.05/fedSAMVendorBusinessUnits/300100564970239",
            "name": "fedSAMVendorBusinessUnits",
            "kind": "item"
        }
    ]
}