Update a referral body
patch
/fscmRestApi/resources/11.13.18.05/publicSectorReferralBodies/{publicSectorReferralBodiesUniqID}
Request
Path Parameters
-
publicSectorReferralBodiesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Referral Bodies resource and used to uniquely identify an instance of Referral Bodies. The client should not generate the hash key value. Instead, the client should query on the Referral Bodies collection resource in order to navigate to a specific instance of Referral Bodies to get the hash key.
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
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:500
The description of the referral body. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates that the referral body is available for use. -
Name: string
Title:
Name
Maximum Length:200
The name of the referral body. -
ReferralType: string
Title:
Referral Type
Maximum Length:100
Indicates the type of the referral.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorReferralBodies-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
Description: string
Title:
Description
Maximum Length:500
The description of the referral body. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates that the referral body is available for use. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:200
The name of the referral body. -
ReferralCode: string
Title:
Referral Code
Maximum Length:100
The unique identifier of the entity to which the incident is referred. -
ReferralType: string
Title:
Referral Type
Maximum Length:100
Indicates the type of the referral.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.