Jump to

• Request
• Response
• Examples

Create rules

post

/fscmRestApi/resources/11.13.18.05/collaborationBusinessUnitResolutionRules

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CollaborationBusinessUnitResolutionRuleId: integer (int64)
  Value that uniquely identifies the collaboration business unit rule.
• OrganizationCode: string
  Title: Organization

  Maximum Length: 49

  Abbreviation that identifies the organization associated with the collaboration business unit rule.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization associated with the collaboration business unit rule.
• ProcurementBUName: string
  Title: Procurement BU

  Maximum Length: 240

  Name of the procurement business unit associated with the collaboration business unit rule.
• SourceSystemCode: string
  Maximum Length: 30

  Abbreviation that identifies the product data model source application for the collaboration business unit rule. Valid values are ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
• SupplierName: string
  Title: Supplier

  Maximum Length: 360

  Name of the supplier associated with the collaboration business unit rule.
• SupplierSiteName: string
  Title: Supplier Site

  Maximum Length: 240

  Name of the supplier site associated with the collaboration business unit rule.

{
    "type":"object",
    "properties":{
        "CollaborationBusinessUnitResolutionRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration business unit rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SupplierName":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier associated with the collaboration business unit rule.",
            "nullable":false
        },
        "ProcurementBUName":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit associated with the collaboration business unit rule.",
            "nullable":false
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":"49",
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the collaboration business unit rule.",
            "nullable":false
        },
        "SourceSystemCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the product data model source application for the collaboration business unit rule. Valid values are ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization associated with the collaboration business unit rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SupplierSiteName":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier site associated with the collaboration business unit rule.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• CollaborationBusinessUnitResolutionRuleId: integer (int64)
  Value that uniquely identifies the collaboration business unit rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the collaboration business unit rule.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the collaboration business unit rule.
• DisplaySupplierName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 255

  Name of the supplier associated with the collaboration business unit rule displayed on the user interface.
• DisplaySupplierSiteName: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 255

  Name of the supplier site associated with the collaboration business unit rule displayed on the user interface.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the collaboration business unit rule.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the collaboration business unit rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Title: Organization

  Maximum Length: 49

  Abbreviation that identifies the organization associated with the collaboration business unit rule.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization associated with the collaboration business unit rule.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 255

  Name of the organization associated with the collaboration business unit rule.
• ProcurementBUName: string
  Title: Procurement BU

  Maximum Length: 240

  Name of the procurement business unit associated with the collaboration business unit rule.
• SourceSystem: string
  Read Only: true

  Maximum Length: 80

  Product data model source application for the collaboration business unit rule. Valid values are External or Oracle.
• SourceSystemCode: string
  Maximum Length: 30

  Abbreviation that identifies the product data model source application for the collaboration business unit rule. Valid values are ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
• SupplierName: string
  Title: Supplier

  Maximum Length: 360

  Name of the supplier associated with the collaboration business unit rule.
• SupplierSiteName: string
  Title: Supplier Site

  Maximum Length: 240

  Name of the supplier site associated with the collaboration business unit rule.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization associated with the collaboration business unit rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the collaboration business unit rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the collaboration business unit rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the collaboration business unit rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollaborationBusinessUnitResolutionRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration business unit rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization associated with the collaboration business unit rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSiteName":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier site associated with the collaboration business unit rule.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplaySupplierSiteName":{
            "title":"Supplier Site",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier site associated with the collaboration business unit rule displayed on the user interface.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier associated with the collaboration business unit rule.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcurementBUName":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit associated with the collaboration business unit rule.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":"49",
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the collaboration business unit rule.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystemCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the product data model source application for the collaboration business unit rule. Valid values are ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySupplierName":{
            "title":"Supplier",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier associated with the collaboration business unit rule displayed on the user interface.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":"80",
            "type":"string",
            "description":"Product data model source application for the collaboration business unit rule. Valid values are External or Oracle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the collaboration business unit rule.",
            "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

Examples

This example describes how to create rules.

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/collaborationBusinessUnitResolutionRules"

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.

{
	"OrganizationCode": "M1",
	"ProcurementBUName": "Vision Operations",
	"SupplierName": "CV_SuppA01",
	"SupplierSiteName": "ORA_VCS_ALL",
	"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE"
}

Example Response Body

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

{
	"CollaborationBusinessUnitResolutionRuleId": 300100545617038,
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"OrganizationName": null,
	"ProcurementBUName": "Vision Operations",
	"SupplierName": "CV_SuppA01",
	"SupplierSiteName": "ORA_VCS_ALL",
	"SourceSystem": null,
	"SourceSystemCode": "ORA_VCS_SRCSYSTEM_ORACLE",
	"CreatedBy": "PLANNER",
	"CreationDate": "2021-02-23T16:11:18+00:00",
	"LastUpdatedBy": "PLANNER",
	"LastUpdateDate": "2021-02-23T16:11:18.148+00:00",
	"@context": {
		"key": "300100545617038",
		"headers": {
			"ETag": "{ETagValue}"
		},
		"links": [
		{
			...
		},
		{
			...
		}
		]
	}
}

Back to Top