Jump to

• Request
• Response

Update a referral body

patch

/fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies/{ReferralCode}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• ReferralCode: string
  The unique identifier of the entity to which the incident is referred.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorReferralBodies-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the referral body.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates that the referral body is available for use.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Title: Name

  Maximum Length: 200

  The name of the referral body.
• ReferralCode(optional): string
  Title: Referral Code

  Maximum Length: 100

  The unique identifier of the entity to which the incident is referred.
• ReferralType(optional): string
  Title: Referral Type

  Maximum Length: 100

  Indicates the type of the referral.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the referral body.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the referral body is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the referral body.",
            "title":"Name"
        },
        "ReferralCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the entity to which the incident is referred.",
            "title":"Referral Code"
        },
        "ReferralType":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates the type of the referral.",
            "title":"Referral Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorReferralBodies-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  The description of the referral body.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates that the referral body is available for use.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Title: Name

  Maximum Length: 200

  The name of the referral body.
• ReferralCode(optional): string
  Title: Referral Code

  Maximum Length: 100

  The unique identifier of the entity to which the incident is referred.
• ReferralType(optional): string
  Title: Referral Type

  Maximum Length: 100

  Indicates the type of the referral.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the referral body.",
            "title":"Description"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the referral body is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the referral body.",
            "title":"Name"
        },
        "ReferralCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the entity to which the incident is referred.",
            "title":"Referral Code"
        },
        "ReferralType":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates the type of the referral.",
            "title":"Referral Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top