Jump to

• Request
• Response

Update a hearing body day recurrence

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHearingBodyDayRecurrences/{publicSectorHearingBodyDayRecurrencesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorHearingBodyDayRecurrencesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId, HearingBodyCode and Occurrence ---for the Hearing Body Day Recurrences resource and used to uniquely identify an instance of Hearing Body Day Recurrences. The client should not generate the hash key value. Instead, the client should query on the Hearing Body Day Recurrences collection resource with a filter on the primary key values in order to navigate to a specific instance of Hearing Body Day Recurrences.
  
  For example: publicSectorHearingBodyDayRecurrences?q=AgencyId=<value1>;HearingBodyCode=<value2>;Occurrence=<value3>

Body ()

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

Root Schema : publicSectorHearingBodyDayRecurrences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the hearing body day recurrence.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the hearing body day recurrence was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates that the hearing body day recurrence is available to use.
• HearingBodyCode(optional): string
  Title: Hearing Body Code

  Maximum Length: 60

  The unique identifier of the hearing body.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the hearing body day recurrence was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the hearing body day recurrence.
• links(optional): array Items
  Title: Items

  Link Relations
• Occurrence(optional): integer(int32)
  Title: Date

  The date of the hearing body occurrence.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency.",
            "type":"integer",
            "format":"int32"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The name of the user who created the hearing body day recurrence.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the hearing body day recurrence was created.",
            "type":"string",
            "format":"date-time"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates that the hearing body day recurrence is available to use.",
            "type":"boolean"
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "description":"The unique identifier of the hearing body.",
            "type":"string",
            "maxLength":60
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the hearing body day recurrence was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the hearing body day recurrence.",
            "type":"string",
            "maxLength":64
        },
        "Occurrence":{
            "title":"Date",
            "description":"The date of the hearing body occurrence.",
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorHearingBodyDayRecurrences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the hearing body day recurrence.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the hearing body day recurrence was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates that the hearing body day recurrence is available to use.
• HearingBodyCode(optional): string
  Title: Hearing Body Code

  Maximum Length: 60

  The unique identifier of the hearing body.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the hearing body day recurrence was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the hearing body day recurrence.
• links(optional): array Items
  Title: Items

  Link Relations
• Occurrence(optional): integer(int32)
  Title: Date

  The date of the hearing body occurrence.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency.",
            "type":"integer",
            "format":"int32"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The name of the user who created the hearing body day recurrence.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the hearing body day recurrence was created.",
            "type":"string",
            "format":"date-time"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates that the hearing body day recurrence is available to use.",
            "type":"boolean"
        },
        "HearingBodyCode":{
            "title":"Hearing Body Code",
            "description":"The unique identifier of the hearing body.",
            "type":"string",
            "maxLength":60
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the hearing body day recurrence was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the hearing body day recurrence.",
            "type":"string",
            "maxLength":64
        },
        "Occurrence":{
            "title":"Date",
            "description":"The date of the hearing body occurrence.",
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top