Jump to

• Request
• Response

Update a web form

patch

/fscmRestApi/resources/11.13.18.05/publicSectorWebFormResponses/{LogMessageId}/child/WebForms/{WebformId}

Request

Supported Media Types

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

Path Parameters

• LogMessageId: integer
  The unique identifier of the communication message. This ID generated automatically by the application.
• WebformId: integer
  The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.

Body ()

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

Root Schema : publicSectorWebFormResponses-WebForms-item

Type: object

Show Source

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

  The unique identifier for the agency associated with the web form.
• AnswerDate(optional): string(date)
  The date and time answer of the web form message.
• AnswerNumber(optional): number
  The numeric answer of the web form message.
• AnswerText(optional): string
  Maximum Length: 1000

  The text answer of the web form message.
• AnswerType(optional): string
  Title: Answer Type

  Maximum Length: 15

  The answer type of the web form message.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the web form message.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The creation date of the web form message.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the web form message was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the web form message.
• links(optional): array Items
  Title: Items

  Link Relations
• LogId(optional): integer(int64)
  Title: Log ID

  The unique identifier of the log associated with the web form message.
• LogMessageId(optional): integer(int64)
  Title: Log Message ID

  The unique identifier for the communication message.
• Question(optional): string
  Title: Question Text

  Maximum Length: 1000

  The question text of the web form message.
• WebformId(optional): integer(int64)
  Title: Web Form ID

  The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the web form.",
            "title":"Agency ID"
        },
        "AnswerDate":{
            "format":"date",
            "type":"string",
            "description":"The date and time answer of the web form message."
        },
        "AnswerNumber":{
            "type":"number",
            "description":"The numeric answer of the web form message."
        },
        "AnswerText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text answer of the web form message."
        },
        "AnswerType":{
            "maxLength":15,
            "type":"string",
            "description":"The answer type of the web form message.",
            "title":"Answer Type"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the web form message.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The creation date of the web form message.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the web form message was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the web form message.",
            "title":"Last Updated By"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the log associated with the web form message.",
            "title":"Log ID"
        },
        "LogMessageId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication message.",
            "title":"Log Message ID"
        },
        "Question":{
            "maxLength":1000,
            "type":"string",
            "description":"The question text of the web form message.",
            "title":"Question Text"
        },
        "WebformId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.",
            "title":"Web Form ID"
        },
        "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 : publicSectorWebFormResponses-WebForms-item

Type: object

Show Source

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

  The unique identifier for the agency associated with the web form.
• AnswerDate(optional): string(date)
  The date and time answer of the web form message.
• AnswerNumber(optional): number
  The numeric answer of the web form message.
• AnswerText(optional): string
  Maximum Length: 1000

  The text answer of the web form message.
• AnswerType(optional): string
  Title: Answer Type

  Maximum Length: 15

  The answer type of the web form message.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the web form message.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The creation date of the web form message.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the web form message was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the web form message.
• links(optional): array Items
  Title: Items

  Link Relations
• LogId(optional): integer(int64)
  Title: Log ID

  The unique identifier of the log associated with the web form message.
• LogMessageId(optional): integer(int64)
  Title: Log Message ID

  The unique identifier for the communication message.
• Question(optional): string
  Title: Question Text

  Maximum Length: 1000

  The question text of the web form message.
• WebformId(optional): integer(int64)
  Title: Web Form ID

  The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the web form.",
            "title":"Agency ID"
        },
        "AnswerDate":{
            "format":"date",
            "type":"string",
            "description":"The date and time answer of the web form message."
        },
        "AnswerNumber":{
            "type":"number",
            "description":"The numeric answer of the web form message."
        },
        "AnswerText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text answer of the web form message."
        },
        "AnswerType":{
            "maxLength":15,
            "type":"string",
            "description":"The answer type of the web form message.",
            "title":"Answer Type"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the web form message.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The creation date of the web form message.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the web form message was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the web form message.",
            "title":"Last Updated By"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the log associated with the web form message.",
            "title":"Log ID"
        },
        "LogMessageId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication message.",
            "title":"Log Message ID"
        },
        "Question":{
            "maxLength":1000,
            "type":"string",
            "description":"The question text of the web form message.",
            "title":"Question Text"
        },
        "WebformId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.",
            "title":"Web Form ID"
        },
        "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