Jump to

• Request
• Response

Update a regulatory authority

patch

/fscmRestApi/resources/11.13.18.05/recallRegulatoryAuthorities/{RegulatoryAuthorityId}

Request

Path Parameters

• RegulatoryAuthorityId(required): integer(int64)
  Value that uniquely identifies the regulatory authority.

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address: string
  Title: Address

  Maximum Length: 600

  Address of the office of the regulatory authority.
• 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.
• 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":{
        "Address":{
            "title":"Address",
            "maxLength":600,
            "type":"string",
            "description":"Address of the office 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
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "Phone":{
            "title":"Phone",
            "maxLength":30,
            "type":"string",
            "description":"Contact number of the office of the regulatory authority.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the office of the regulatory authority.",
            "nullable":true
        },
        "RegulatoryAuthorityURL":{
            "title":"URL",
            "maxLength":200,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the regulatory authority portal.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":30,
            "type":"string",
            "description":"State in which the office of the regulatory authority is located.",
            "nullable":true
        }
    }
}

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 : 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":{
        "Address":{
            "title":"Address",
            "maxLength":600,
            "type":"string",
            "description":"Address of the office of the regulatory authority.",
            "nullable":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
        },
        "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
        },
        "City":{
            "title":"City",
            "maxLength":30,
            "type":"string",
            "description":"City in which the office of the regulatory authority is located.",
            "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
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":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
        },
        "Phone":{
            "title":"Phone",
            "maxLength":30,
            "type":"string",
            "description":"Contact number of the office of the regulatory authority.",
            "nullable":true,
            "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
        },
        "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
        },
        "RegulatoryAuthorityName":{
            "title":"Regulatory Authority Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the regulatory authority.",
            "nullable":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
        },
        "State":{
            "title":"State",
            "maxLength":30,
            "type":"string",
            "description":"State in which the office of the regulatory authority is located.",
            "nullable":true,
            "x-queryable":true
        },
        "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