Jump to

• Request
• Response

Update a web form

patch

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

Request

Path Parameters

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

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AnswerDate: string (date)
  The date and time answer of the web form message.
• AnswerNumber: number
  The numeric answer of the web form message.
• AnswerText: string
  Maximum Length: 1000

  The text answer of the web form message.

{
    "type":"object",
    "properties":{
        "AnswerText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text answer of the web form message.",
            "nullable":true
        },
        "AnswerDate":{
            "type":"string",
            "description":"The date and time answer of the web form message.",
            "format":"date",
            "nullable":true
        },
        "AnswerNumber":{
            "type":"number",
            "description":"The numeric answer of the web form message.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":3
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorWebFormResponses-WebForms-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

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

  Maximum Length: 15

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the web form message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogId: integer (int64)
  Title: Log ID

  Read Only: true

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

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

  Maximum Length: 1000

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

  Read Only: true

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the web form message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The creation date of the web form message.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the web form message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the web form.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "WebformId":{
            "title":"Web Form ID",
            "type":"integer",
            "description":"The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AnswerText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text answer of the web form message.",
            "nullable":true,
            "x-queryable":true
        },
        "LogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier for the communication message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AnswerNumber":{
            "type":"number",
            "description":"The numeric answer of the web form message.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":3
            },
            "x-queryable":true
        },
        "AnswerDate":{
            "type":"string",
            "description":"The date and time answer of the web form message.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Question":{
            "title":"Question Text",
            "maxLength":1000,
            "type":"string",
            "description":"The question text of the web form message.",
            "nullable":false,
            "x-queryable":true
        },
        "AnswerType":{
            "title":"Answer Type",
            "maxLength":15,
            "type":"string",
            "description":"The answer type of the web form message.",
            "nullable":false,
            "x-queryable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier of the log associated with the web form message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date that the web form message was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top