Forms

Retrieve a form by ID

Use the select query parameter to specify which fields to include.

get/public/v1/helpdesk/forms/{id}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/helpdesk/forms/{id}
  • Auth: none declared

Path parameters

idstring required

The form ID.

Query parameters

selectstring

Optional select statement to filter fields.

Response

OK

idstring
namestring
iconstring nullable
revisioninteger
descriptionstring nullable

Gets or sets the description associated with the form.

status'Unpublished' | 'Published'
externalIdstring nullable

Gets or sets the optional external identifier associated with the form.

isDeletedboolean

Indicates whether the queue has been marked as deleted.

Changes

No recorded changes to this operation across all 1 revision of this API.