REST API for Oracle Supply Chain Management Cloud

Create regulatory authorities

post

/fscmRestApi/resources/11.13.18.05/recallRegulatoryAuthorities

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

Address: string

Title: Address

Maximum Length: 600

Address of the office of the regulatory authority.
BusinessUnitId: integer (int64)

Value that uniquely identifies the business unit to which the regulatory authority is associated.
BusinessUnitName: string

Title: Business Unit

Maximum Length: 240

Name of the business unit to which the regulatory authority is associated.
City: string

Title: City

Maximum Length: 30

City in which the office of the regulatory authority is located.
Country: string

Title: Country

Maximum Length: 30

Country in which the office of the regulatory authority is located.
CountryName: string

Title: Country

Maximum Length: 80

Name of the country in which the office of the regulatory authority is located.
ObjectVersionNumber: integer (int32)

Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
Phone: string

Title: Phone

Maximum Length: 30

Contact number of the office of the regulatory authority.
PostalCode: string

Title: Postal Code

Maximum Length: 30

Postal code of the office of the regulatory authority.
RegulatoryAuthorityId: integer (int64)

Value that uniquely identifies the regulatory authority.
RegulatoryAuthorityName: string

Title: Regulatory Authority Name

Maximum Length: 120

Name of the regulatory authority.
RegulatoryAuthorityURL: string

Title: URL

Maximum Length: 200

URL (Uniform Resource Locator) of the regulatory authority portal.
State: string

Title: State

Maximum Length: 30

State in which the office of the regulatory authority is located.

{
    "type":"object",
    "properties":{
        "RegulatoryAuthorityURL":{
            "title":"URL",
            "maxLength":"200",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the regulatory authority portal.",
            "nullable":true
        },
        "Address":{
            "title":"Address",
            "maxLength":"600",
            "type":"string",
            "description":"Address of the office of the regulatory authority.",
            "nullable":true
        },
        "CountryName":{
            "title":"Country",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the country in which the office of the regulatory authority is located.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RegulatoryAuthorityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the regulatory authority.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit to which the regulatory authority is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BusinessUnitName"
                ]
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"30",
            "type":"string",
            "description":"Postal code of the office of the regulatory authority.",
            "nullable":true
        },
        "RegulatoryAuthorityName":{
            "title":"Regulatory Authority Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the regulatory authority.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":"30",
            "type":"string",
            "description":"City in which the office of the regulatory authority is located.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "State":{
            "title":"State",
            "maxLength":"30",
            "type":"string",
            "description":"State in which the office of the regulatory authority is located.",
            "nullable":true
        },
        "Phone":{
            "title":"Phone",
            "maxLength":"30",
            "type":"string",
            "description":"Contact number of the office of the regulatory authority.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"30",
            "type":"string",
            "description":"Country in which the office of the regulatory authority is located.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CountryName"
                ]
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit to which the regulatory authority is associated.",
            "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 : recallRegulatoryAuthorities-item-response

Type: object

Show Source

Address: string

Title: Address

Maximum Length: 600

Address of the office of the regulatory authority.
BusinessUnitId: integer (int64)

Value that uniquely identifies the business unit to which the regulatory authority is associated.
BusinessUnitName: string

Title: Business Unit

Maximum Length: 240

Name of the business unit to which the regulatory authority is associated.
City: string

Title: City

Maximum Length: 30

City in which the office of the regulatory authority is located.
Country: string

Title: Country

Maximum Length: 30

Country in which the office of the regulatory authority is located.
CountryName: string

Title: Country

Maximum Length: 80

Name of the country in which the office of the regulatory authority is located.
CreatedBy: string

Read Only: true

Maximum Length: 64

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

Read Only: true

Date and time when the user created the record.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the user most recently updated the record.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who most recently updated the record.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

Login that the user used when updating the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
ObjectVersionNumber: integer (int32)

Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
Phone: string

Title: Phone

Maximum Length: 30

Contact number of the office of the regulatory authority.
PostalCode: string

Title: Postal Code

Maximum Length: 30

Postal code of the office of the regulatory authority.
RegulatoryAuthorityId: integer (int64)

Value that uniquely identifies the regulatory authority.
RegulatoryAuthorityName: string

Title: Regulatory Authority Name

Maximum Length: 120

Name of the regulatory authority.
RegulatoryAuthorityURL: string

Title: URL

Maximum Length: 200

URL (Uniform Resource Locator) of the regulatory authority portal.
State: string

Title: State

Maximum Length: 30

State in which the office of the regulatory authority is located.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RegulatoryAuthorityURL":{
            "title":"URL",
            "maxLength":"200",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the regulatory authority portal.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address":{
            "title":"Address",
            "maxLength":"600",
            "type":"string",
            "description":"Address of the office of the regulatory authority.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the country in which the office of the regulatory authority is located.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RegulatoryAuthorityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the regulatory authority.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit to which the regulatory authority is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"30",
            "type":"string",
            "description":"Postal code of the office of the regulatory authority.",
            "nullable":true,
            "x-queryable":true
        },
        "RegulatoryAuthorityName":{
            "title":"Regulatory Authority Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the regulatory authority.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"30",
            "type":"string",
            "description":"City in which the office of the regulatory authority is located.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"30",
            "type":"string",
            "description":"State in which the office of the regulatory authority is located.",
            "nullable":true,
            "x-queryable":true
        },
        "Phone":{
            "title":"Phone",
            "maxLength":"30",
            "type":"string",
            "description":"Contact number of the office of the regulatory authority.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"30",
            "type":"string",
            "description":"Country in which the office of the regulatory authority is located.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CountryName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit to which the regulatory authority is associated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating 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

This example describes how to create regulatory authorities.

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

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.

{
	"BusinessUnitName": "Vision Healthcare USA",
	"RegulatoryAuthorityName": "ABC12",
	"RegulatoryAuthorityURL": "www.example.com",
	"Address": "Example Inc.",
	"State": "CA",
	"City": "Redwood Shores",
	"Country": "US",
	"Phone": "6035550100",
	"PostalCode": "94065"
}

Example Response Body

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

{
	"RegulatoryAuthorityId": 300100238759984,
	"RegulatoryAuthorityName": "ABC12",
	"BusinessUnitId": 300100200125593,
	"BusinessUnitName": "Vision Healthcare USA",
	"RegulatoryAuthorityURL": "www.example.com",
	"Address": "Example Inc.",
	"State": "CA",
	"City": "Redwood Shores",
	"Country": "US",
	"CountryName": "United States",
	"Phone": "6035550100",
	"PostalCode": "94065",
	"CreatedBy": "User1",
	"CreationDate": "2020-08-20T09:26:54+00:00",
	"LastUpdateDate": "2020-08-20T09:26:54.039+00:00",
	"LastUpdateLogin": "AD35156A6FF68705E053D48DF50A120B",
	"LastUpdatedBy": "User1",
	"ObjectVersionNumber": 1,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/recallRegulatoryAuthorities/300100238759984",
		"name": "recallRegulatoryAuthorities",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/recallRegulatoryAuthorities/300100238759984",
		"name": "recallRegulatoryAuthorities",
		"kind": "item"
	}
	]
}