Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Page Tree
rootUsing Dashboard API to Manage Fields

Excerpt
hiddentrue

Field

  • GET api/v9/Field

    Gets all Fields

    Parameters

    • version: (FromUri)

  • GET api/v9/Field/{id}

    Gets a Field with id provided

    Parameters

    • id: Id of a Field to be loaded (FromUri)

    • version: (FromUri)

  • GET api/v9/Field/{guid}

    Gets a Field with Guid provided

    Parameters

    • guid: Guid of a Field to be loaded (FromUri)

    • version: (FromUri)

  • GET api/v9/Field?fieldName={fieldName}

    Get a Field by its name

    Parameters

    • fieldName: Name of a Field to retrieve (FromUri)

    • version: (FromUri)

  • POST api/v9/Field

    Adds a new Field

    Parameters

    • value: A Field object to be added (FromBody)

    • version: (FromUri)

  • PUT api/v9/Field/{id}

    Updates an existing Field

    Parameters

    • id: Guid of a Field to be updated (FromUri)

    • value: A Field object to be updated (FromBody)

    • version: (FromUri)

  • PUT api/v9/Field/{guid}

    Updates an existing Field

    Parameters

    • guid: Id of a Field to be updated (FromUri)

    • value: A Field object to be updated (FromBody)

    • version: (FromUri)

  • DELETE api/v9/Field/{id}

    Deletes a Field

    Parameters

    • id: Id of a Field to be deleted (FromUri)

    • version: (FromUri)

  • DELETE api/v9/Field/{guid}

    Deletes a Field

    Parameters

    • guid: Guid of a Field to be deleted (FromUri)

    • version: (FromUri)