Exploring the Graviti api
Get api v1 connect components
Get a list of components that are available on the administration portal
GET/api/v1/Connect/components
Get a list of components that are available on the administration portal.
REQUEST INFORMATION
Parameters
Name |
Type |
Additional information |
Access Type Id |
Integer |
|
Content Source Type Id |
Integer |
|
Key |
String |
|
Entity Id |
String |
|
Page size |
Integer |
|
Page |
Integer |
|
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",
"name": "string",
"title": "string",
"contentSource": "string",
"displayOrder": 0,
"orgnizationId": "string",
"accessTypeId": 0,
"created": "2023-12-06T11:23:03.221Z",
"updated": "2023-12-06T11:23:03.221Z",
"user": "string",
"contentSourceTypeId": 0,
"accessType": "string",
"contentSourceType": "string"
}
],
"totalPages": 0,
"hasPreviousPage": true,
"hasNextPage": true,
"nextPageNumber": 0,
"previousPageNumber": 0
}
Field |
Type |
Description |
Id |
String |
Internal ID to identify announcement |
Name |
Boolean |
The name of the component |
Title |
String |
Title of the component |
Content Source |
String |
The content source of the component |
Display order |
integer |
The display order of the component |
Organization id |
String |
Id to identify the organization |
Access type id |
Integer |
Access type id to identify component access type |
Created |
Datetime |
Datetime when the component was created in the system |
Updated |
Datetime |
Datetime when the component was last updated. |
User |
String |
The name of the person who wrote the component |
Content source type id |
Integer |
The content source type id of the component |
Access type |
String |
component access type |
Content source type |
String |
The content source type of the component |
Related topics