Jump to

• Request
• Response

Create a set of digital assistant setups

post

/fscmRestApi/resources/11.13.18.05/publicSectorDigitalAssistantSetups

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorDigitalAssistantSetups-item

Type: object

Show Source

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

  The agency ID of the record.
• ApplicationId(optional): string
  Title: Channel ID

  Maximum Length: 50

  The application ID of the digital assistant.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time of the creation of the row.
• CustomOptionsObject(optional): string
  Title: Custom Options

  The custom options of the digital assistant.
• HeaderText(optional): string
  Title: Header

  Maximum Length: 40

  The header text of the digital assistant.
• InputPlaceholderText(optional): string
  Title: Text Entry

  Maximum Length: 30

  The text to enter in the digital assistant.
• IntroductionText(optional): string
  Title: Introduction

  Maximum Length: 100

  The introduction text of the digital assistant.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• SendButtonText(optional): string
  Title: Send Button

  Maximum Length: 20

  The text for the send button on the digital assistant.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "ApplicationId":{
            "maxLength":50,
            "type":"string",
            "description":"The application ID of the digital assistant.",
            "title":"Channel ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time of the creation of the row.",
            "title":"Creation Date"
        },
        "CustomOptionsObject":{
            "type":"string",
            "description":"The custom options of the digital assistant.",
            "title":"Custom Options"
        },
        "HeaderText":{
            "maxLength":40,
            "type":"string",
            "description":"The header text of the digital assistant.",
            "title":"Header"
        },
        "InputPlaceholderText":{
            "maxLength":30,
            "type":"string",
            "description":"The text to enter in the digital assistant.",
            "title":"Text Entry"
        },
        "IntroductionText":{
            "maxLength":100,
            "type":"string",
            "description":"The introduction text of the digital assistant.",
            "title":"Introduction"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "SendButtonText":{
            "maxLength":20,
            "type":"string",
            "description":"The text for the send button on the digital assistant.",
            "title":"Send Button"
        },
        "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 : publicSectorDigitalAssistantSetups-item

Type: object

Show Source

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

  The agency ID of the record.
• ApplicationId(optional): string
  Title: Channel ID

  Maximum Length: 50

  The application ID of the digital assistant.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date and time of the creation of the row.
• CustomOptionsObject(optional): string
  Title: Custom Options

  The custom options of the digital assistant.
• HeaderText(optional): string
  Title: Header

  Maximum Length: 40

  The header text of the digital assistant.
• InputPlaceholderText(optional): string
  Title: Text Entry

  Maximum Length: 30

  The text to enter in the digital assistant.
• IntroductionText(optional): string
  Title: Introduction

  Maximum Length: 100

  The introduction text of the digital assistant.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• SendButtonText(optional): string
  Title: Send Button

  Maximum Length: 20

  The text for the send button on the digital assistant.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency ID of the record.",
            "title":"Agency ID"
        },
        "ApplicationId":{
            "maxLength":50,
            "type":"string",
            "description":"The application ID of the digital assistant.",
            "title":"Channel ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time of the creation of the row.",
            "title":"Creation Date"
        },
        "CustomOptionsObject":{
            "type":"string",
            "description":"The custom options of the digital assistant.",
            "title":"Custom Options"
        },
        "HeaderText":{
            "maxLength":40,
            "type":"string",
            "description":"The header text of the digital assistant.",
            "title":"Header"
        },
        "InputPlaceholderText":{
            "maxLength":30,
            "type":"string",
            "description":"The text to enter in the digital assistant.",
            "title":"Text Entry"
        },
        "IntroductionText":{
            "maxLength":100,
            "type":"string",
            "description":"The introduction text of the digital assistant.",
            "title":"Introduction"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "SendButtonText":{
            "maxLength":20,
            "type":"string",
            "description":"The text for the send button on the digital assistant.",
            "title":"Send Button"
        },
        "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