Back to resources

Exploring the Graviti api

Get api v1 organizations features by organizations id

Get a list of the features within the organization by using organization id


GET/api/v1/Organizations/{id}/features

Get A List Of The Features Within The Organization, By Organization ID

REQUEST INFORMATION

Parameters

Name

Type

Additional information

Key

String

 

Entity Id

String

 

Page Size

Integer

 

Page

Integer

 

Id

String

Required

x-api-key

Header

Required

x-api-secret 

Header

Required

 

RESPONSE INFORMATION

  • Code: 200
  • Description: successful
  • Media type: text/plain; application/json; text/json
  • Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "featureId": "string",
      "customLabel": "string",
      "controller": "string",
      "icon": "string",
      "hasSubmenu": true,
      "hasLink": true,
      "link": "string",
      "displayorder": 0,
      "created": "2023-12-08T08:57:02.176Z",
      "updated": "2023-12-08T08:57:02.176Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field

Type

Description

Id

String

Internal ID to identify feature

Organization id

Boolean

Internal ID to identify organization

Feature id

Boolean

Feature id

Custom label

Boolean

Custom label

Controller

Boolean

Controller

Icon

Boolean

Icon

Hs sub menu

Boolean

Has sub menu

Hs link

Boolean

Has link

Link

String

Feature Link

Display order

Integer 

Display order number

Created

Datetime

Datetime when the feature record was created in the system

Updated

Datetime

Datetime when the feature record was last updated in the system



Related topics