Option /{option-id}

An option from the Nexty Store. Options are created and managed by Nexty.

Reading

GET /option/{option-id} HTTP/1.1
Host: localhost:3000

Permissions

  • At least one of the following criteria must be met :
    • The privacy field of the app is set to GLOBAL.
    • The privacy field of the app is set to PUBLIC, all of the following criteria is met :
      • An access token with workspace_environment permission is provided.
      • If access token points to a workspace, the option must be attached to the current workspace.
      • If access token points to an user, the current person is a member of the workspace at which is attached the option.

Fields

Name Description Type

_id

The option ID.

string

name

The name of the option.

string

avatar

The ID of the Photo that represents the avatar of the option.

Photo

description

The description of the option.

string

privacy

The privacy of the option.

string{GLOBAL, PUBLIC, PRIVATE}

workspace

The ID of the Workspace at which is attached the option.
Only if privacy field is set to PUBLIC or PRIVATE.

Workspace

created_time

The date that indicates when the option was created.

date

updated_time

The date that indicates when the option was updated for the last time.

date

Publishing

You can't create options. Options are published and managed by Nexty.

Updating

You can't update options. Options are published and managed by Nexty.

Deleting

You can't delete options. Options are published and managed by Nexty.

Edges

No edges.