Core - Ext Resource Group

The base url for the APIs in this page is at:

/api/admin

A JSON file with OpenAPI data about all core-related admin APIs can be downloaded here.

Gets external resource groups list

Gets the list of all external resource groups (it’s a Paged List APIs, as explained in the introduction):

GET /v1/resource-groups/list

Gets the list of external resource groups

Status Codes

200 OK – Success

The request will return a list of the external resource groups:

[
  {
    ID: 1234,                                                     // Int
    CreatedDate: "2001-01-01T01:01:01Z",                          // DateTime
    LastUpdated: "2001-01-01T01:01:01Z",                          // DateTime
    Name: "ResourceGroupName",                                    // String
    Communitioes: ["53155c4a-b2a0-412f-ab41-552d9ccdf784",...]    // Guid Array
  },
  ...
]

Get external resource groups list by module

Gets the short list of external resource groups by module:

GET /v1/resource-groups/by-module/{id}

Gets the short list of external resource groups by module

Parameters

id (integer) – The id of a module

Status Codes

200 OK – Success

id: The id of a module (Int)

Returns a Json positive response with the the shortlist:

[
  {
    ID: 123,                     // Int
    Name: "ResourceGroupName"    // String
  },
  ...
]

Get external resource groups by user

Gets the guid list of the external resource groups visible by the user

GET /v1/resource-groups/by-user/{guid}

Gets the list of the resource groups usable by a specified user

Parameters

guid (string) – The guid of the user

Status Codes

200 OK – Success

guid: The guid of the user

Returns a Json positive response with the guid list:

[ "c4ec565a-27d2-4b1d-8464-b55fdd9367f9", "a10e77b3-9a9a-424b-958d-108a4061440b", ... ]