File Groups

List Groups

Copy

Copied

curl -X GET
  https://api.xsignals.xpansiv.com/file/group?from=0&size=10&query=value1&writeOnly=false

List all groups you are entitled to

Response:

jsonshell

Copy

Copied

{
    "from": 0,
    "totalSize": 1,
    "items": [
        {
            "access": "group access level [R|W|S], sample: RW",
            "shared": false,
            "name": "group name",
            "description": "group description",
            "fields": [
                {
                  "name": "field name", 
                  "type": "field type [string|int|float|date|array]",
                  "defaultValue": "field value"			
                },{
                  "name": "field name 2", 
                  "type": "field type 2 [string|int|float|date|array]"	
                }
            ]
        }
    ]
}

Copy

Copied

curl -X GET
  https://api.xsignals.xpansiv.com/file/group?from=0&size=10&query=<searchString>1&writeOnly=false

List all groups containing the 'searchString' that you can read write

Copy

Copied

curl -X GET
  https://api.xsignals.xpansiv.com/file/group?query=name=*&withSymbol=true

List of file groups which have symbols

This endpoint all you to list all the groups you are entitled to, in addition you can use this endpoint to search for group with given value in the name, description or fields. By default, the endpoint returns max. 100 items per request.

HTTP Request

GET https://api.xsignals.xpansiv.com/file/group

URL Parameters

Parameter	Description
from	Index where list starts, used to load data in chunks. Default value is 0.
size	Number of records to return. Max size is 1000. Default size is 100.
query	Value of the description, name or fields to look for.
writeOnly	If this parameter is set to true, only groups to which user has write access are returned.
withSymbol	If this parameter is set to true, only groups which have some symbols are returned.
sortBy	Field by which the results will be sorted. Either createdOn or name. Default to createdOn.
sortOrder	Order in which items will be returned. Available values are asc and desc. Default to desc.

Group Details

Copy

Copied

curl https://api.xsignals.xpansiv.com/file/group/{name}
	-H "Authorization: Bearer yourNgToken"

The above command returns a JSON file structured as follows:

Copy

Copied

{
  "name": "group name", 
  "description": "group description", 
  "fields": [
    {
      "name": "field name", 
      "type": "field type [string|int|float|date|array]"			
    },{
      "name": "field name 2", 
      "type": "field type 2 [string|int|float|date|array]",
      "defaultValue": "field value"	
    }
  ] 
}

This endpoint retrieves details about a specific file group.

HTTP Request

GET https://api.xsignals.xpansiv.com/file/group/{name}

URL Parameters

Parameter	Description
name	Name of the group to retrieve