GET api/v1/forms/instructions/{FormId}/instructions

List form instruction

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FormId

Form id

universally unique identifier

Required

Filter

Filter records

ListFormInstructionV1Filter

None.

Select

Select columns

Collection of ListFormInstructionV1Select

Default value: All

Example value: CreateDate, Status

Unique items

Sort

Sort records Sort by the first column, then by the second column, and so on

Collection of ListFormInstructionV1Sort

Default value: CreateDateDesc

Example value: CreateDateDesc

Max items: 3

Unique items

PageNumber

Page number

integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647

PageSize

Number of records per page

integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of form instructions

ListFormInstructionV1Response
NameDescriptionTypeAdditional information
Instructions

List of form instructions

Collection of ListFormInstructionV1ResponseInstruction

None.

Total

Total number of records matching the request

integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "Instructions": [
    {
      "FormInstructionId": "5cbf0039a6feee2523549291",
      "Message": "Please fill out this report",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "PublishDate": "2018-12-31T21:59:59.999+00:00",
      "InformationDate": "2018-12-31T21:59:59.999+00:00",
      "Status": "Completed",
      "AppUserIds": [
        "4b663902-8b23-47fe-bedc-4a5d4a669401",
        "4b663902-8b23-47fe-bedc-4a5d4a669502"
      ]
    },
    {
      "FormInstructionId": "5cbf0039a6feee2523549291",
      "Message": "Please fill out this report",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "PublishDate": "2018-12-31T21:59:59.999+00:00",
      "InformationDate": "2018-12-31T21:59:59.999+00:00",
      "Status": "Completed",
      "AppUserIds": [
        "4b663902-8b23-47fe-bedc-4a5d4a669401",
        "4b663902-8b23-47fe-bedc-4a5d4a669502"
      ]
    }
  ],
  "Total": 42
}