Update a digital assistant setup
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups/{AgencyId}
Request
Path Parameters
-
AgencyId(required): integer(int32)
The agency ID of the record.Default Value:
1
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
-
ApplicationId: string
Title:
Channel ID
Maximum Length:50
The application ID of the digital assistant. -
CustomOptionsObject: string
(byte)
Title:
Custom Options
The custom options of the digital assistant. -
HeaderText: string
Title:
Header
Maximum Length:40
The header text of the digital assistant. -
InputPlaceholderText: string
Title:
Text Entry
Maximum Length:30
The text to enter in the digital assistant. -
SendButtonText: string
Title:
Send Button
Maximum Length:20
The text for the send button on the digital assistant.
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 : publicSectorDigitalAssistantSetups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency ID of the record. -
ApplicationId: string
Title:
Channel ID
Maximum Length:50
The application ID of the digital assistant. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of the creation of the row. -
CustomOptionsObject: string
(byte)
Title:
Custom Options
The custom options of the digital assistant. -
HeaderText: string
Title:
Header
Maximum Length:40
The header text of the digital assistant. -
InputPlaceholderText: string
Title:
Text Entry
Maximum Length:30
The text to enter in the digital assistant. -
IntroductionText: string
Title:
Introduction
Read Only:true
Maximum Length:100
The introduction text of the digital assistant. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SendButtonText: string
Title:
Send Button
Maximum Length:20
The text for the send button on the digital assistant.
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.