REST API for Oracle Fusion Cloud SCM

You can use a REST API to get a list of collaboration relationship candidates. Each collaboration relationship candidate is a potential relationship that the application published to Supply Chain Collaboration but has not created as a collaboration relationship.

Let's discuss these scenarios:

Get collaboration relationship candidates according to supplier.
Get collaboration relationship candidates according to type.

Get Collaboration Relationship Candidates According to Supplier

For the example, assume Oracle Supply Planning Cloud created a sales order forecast and you require a list of potential collaboration relationships so you can determine which ones to make collaborative. Your customer must get all potential collaboration relationships for one supplier so they can determine whether Supply Planning created collaboration data for the supplier.

Here's a typical application processing flow for the scenarios:

You send a REST API request from the client to the server.
The response payload includes details that describe the results of the request.

Your partner application extracts the values for these attributes from the response payload, and then displays them in fields in the client.

Attribute	Description
ShipFromSupplierName	Name of the supplier that ships the item.
ShipFromSupplierSiteName	Name of the supplier site that ships the item.
ShipToOrganizationName	Name of the organization that receives the item.
ItemNumber	Number that identifies the item.
ItemDescription	Description of the item.

Example URL

Use this resource URL format to get the top 200 collaboration relationships for supplier Small, Inc

GET

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates?limit=200&q=ShipFromSupplierName=Small, Inc"

Example Response

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "ShipFromSupplierId": 909,
            "ShipFromSupplierName": "Small, Inc",
            "ShipFromSupplierNumber": "5071",
            "ShipFromSupplierSiteId": 2814,
            "ShipFromSupplierSiteName": "BERLIN_HQ",
            "ProcurementBU": "Vision Operations",
            "ShipToOrganizationId": 209,
            "ShipToOrganizationCode": "M2",
            "ShipToOrganizationName": "Tall Manufacturing",
            "ShipToSupplierId": null,
            "ShipToSupplierName": null,
            "ShipToSupplierNumber": null,
            "ShipToSupplierSiteId": null,
            "ShipToSupplierSiteCode": null,
            "InventoryItemId": 300100103293151,
            "InventoryItemOrgId": 209,
            "ItemNumber": "SCC-TMC-02",
            "ItemDescription": "Item Description for SCC-TMC-02",
            "ItemCategory": "Uncategorized",
            "PublishedDate": "2017-08-22T19:51:35+00:00",
            "Type": "ORA_VCS_UNPROCESSED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED00057708000000000000038D0000000EACED000577080000000000000AFE0000000EACED0005770800000000000000D10000000EACED00057708000110F0800DC8DF0000000EACED0005770800000000000000D1000000175643535F554E50524F4345535345445F454E5452494553",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED00057708000000000000038D0000000EACED000577080000000000000AFE0000000EACED0005770800000000000000D10000000EACED00057708000110F0800DC8DF0000000EACED0005770800000000000000D1000000175643535F554E50524F4345535345445F454E5452494553",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                }
            ]
        },
        {
            "ShipFromSupplierId": 909,
            "ShipFromSupplierName": "Small, Inc",
            "ShipFromSupplierNumber": "5071",
            "ShipFromSupplierSiteId": 2814,
            "ShipFromSupplierSiteName": "BERLIN_HQ",
            "ProcurementBU": "Vision Operations",
            "ShipToOrganizationId": 209,
            "ShipToOrganizationCode": "M2",
            "ShipToOrganizationName": "Tall Manufacturing",
            "ShipToSupplierId": null,
            "ShipToSupplierName": null,
            "ShipToSupplierNumber": null,
            "ShipToSupplierSiteId": null,
            "ShipToSupplierSiteCode": null,
            "InventoryItemId": 300100103293185,
            "InventoryItemOrgId": 209,
            "ItemNumber": "SCC-TMC-03",
            "ItemDescription": "Item Description for SCC-TMC-03",
            "ItemCategory": "Uncategorized",
            "PublishedDate": "2017-08-22T19:51:35+00:00",
            "Type": "ORA_VCS_UNPROCESSED",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED00057708000000000000038D0000000EACED000577080000000000000AFE0000000EACED0005770800000000000000D10000000EACED00057708000110F0800DC9010000000EACED0005770800000000000000D1000000175643535F554E50524F4345535345445F454E5452494553",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED00057708000000000000038D0000000EACED000577080000000000000AFE0000000EACED0005770800000000000000D10000000EACED00057708000110F0800DC9010000000EACED0005770800000000000000D1000000175643535F554E50524F4345535345445F454E5452494553",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 200,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates",
            "name": "collaborationRelationshipCandidates",
            "kind": "collection"
        }
    ]
}

Get Collaboration Relationship Candidates According to Type

Assume your customer must get all potential collaboration relationships that apply only in a business-to-business messaging environment.

Here's a typical application processing flow for the scenarios:

You send a REST API request from the client to the server.
The response payload includes details that describe the results of the request.

Your partner application extracts values for each of these attributes from the response payload, and then displays them in fields in the client. Some resources contain only a few attributes. Others might contain several hundred attributes. You can pick and choose the ones to process. This table includes only some of the attributes from the resource.

Attribute	Description
ShipFromSupplierName	Name of the supplier that ships the item.
ShipFromSupplierSiteName	Name of the supplier site that ships the item.
ShipToOrganizationName	Name of the organization that receives the item.
ItemNumber	Number that identifies the item.
ItemDescription	Description of the item.
ProcurementBu	Name of the business unit. The application assigns the supplier to this business unit.
ShipToOrganizationCode	Name of the organization that receives the item.
ItemNumber	Number of the item.
ShipToOrganizationId	Value that uniquely identifies the organization in the relationship candidate. This organization receives the shipment. It is a primary key that the application creates when it creates an organization.

Example URL

Use this resource URL format to get one receipt in organization M1, for vendor Small, Inc, for item AI-F-Bolt1.

GET

curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates?limit=200&q=Type=ORA_VCS_B2BONLY"

Example Response

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "ShipFromSupplierId": 21,
            "ShipFromSupplierName": "Small, Inc",
            "ShipFromSupplierNumber": "1013",
            "ShipFromSupplierSiteId": 300100027834859,
            "ShipFromSupplierSiteName": "ATLANTA",
            "ProcurementBU": "Vision Operations",
            "ShipToOrganizationId": 207,
            "ShipToOrganizationCode": "M1",
            "ShipToOrganizationName": "Tall Manufacturing",
            "ShipToSupplierId": null,
            "ShipToSupplierName": null,
            "ShipToSupplierNumber": null,
            "ShipToSupplierSiteId": null,
            "ShipToSupplierSiteCode": null,
            "InventoryItemId": 300100081232688,
            "InventoryItemOrgId": 207,
            "ItemNumber": "AI-F-Bolt1",
            "ItemDescription": "AI-F-Bolt1\n",
            "ItemCategory": "Uncategorized",
            "PublishedDate": "2017-08-29T20:37:26+00:00",
            "Type": "ORA_VCS_B2BONLY",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED0005770800000000000000150000000EACED00057708000110F07B8E61EB0000000EACED0005770800000000000000CF0000000EACED00057708000110F07EBD2B300000000EACED0005770800000000000000CF0000000E5643535F434F4C4C41425F454E54",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED0005770800000000000000150000000EACED00057708000110F07B8E61EB0000000EACED0005770800000000000000CF0000000EACED00057708000110F07EBD2B300000000EACED0005770800000000000000CF0000000E5643535F434F4C4C41425F454E54",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                }
            ]
        },
        {
            "ShipFromSupplierId": 21,
            "ShipFromSupplierName": "Small, Inc",
            "ShipFromSupplierNumber": "1013",
            "ShipFromSupplierSiteId": 300100027834859,
            "ShipFromSupplierSiteName": "ATLANTA",
            "ProcurementBU": "Vision Operations",
            "ShipToOrganizationId": 207,
            "ShipToOrganizationCode": "M1",
            "ShipToOrganizationName": "Tall Manufacturing",
            "ShipToSupplierId": null,
            "ShipToSupplierName": null,
            "ShipToSupplierNumber": null,
            "ShipToSupplierSiteId": null,
            "ShipToSupplierSiteCode": null,
            "InventoryItemId": 300100082371759,
            "InventoryItemOrgId": 207,
            "ItemNumber": "AI-F-Nut1",
            "ItemDescription": "AI-F-Nut1\n",
            "ItemCategory": "Uncategorized",
            "PublishedDate": "2017-08-29T20:37:26+00:00",
            "Type": "ORA_VCS_B2BONLY",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED0005770800000000000000150000000EACED00057708000110F07B8E61EB0000000EACED0005770800000000000000CF0000000EACED00057708000110F07ECE8CAF0000000EACED0005770800000000000000CF0000000E5643535F434F4C4C41425F454E54",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates/00060000000EACED0005770800000000000000150000000EACED00057708000110F07B8E61EB0000000EACED0005770800000000000000CF0000000EACED00057708000110F07ECE8CAF0000000EACED0005770800000000000000CF0000000E5643535F434F4C4C41425F454E54",
                    "name": "collaborationRelationshipCandidates",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 200,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/collaborationRelationshipCandidates",
            "name": "collaborationRelationshipCandidates",
            "kind": "collection"
        }
    ]
}