Viewing the contents of a resource file

POST /api/v2/resources/toc

Access: General administrator, Tenant administrator, Tier 2 analyst, Tier 1 analyst.

Request body

Format: JSON

Name

Data type

Mandatory

Description

Value example

fileID

string

Yes

The file ID obtained as a result of loading the resource file.

00000000-0000-0000-0000-000000000000

password

string

Yes

Resource file password.

SomePassword!88

Response

HTTP code: 200

Format: JSON

File version, list of resources, categories, and folders.

The ID of the retrieved resources must be used when importing.

type TOCResponse struct {

Folders []*Folder `json:"folders"`

}

type Folder struct {

ID string `json:"id"`

TenantID string `json:"tenantID"`

TenantName string `json:"tenantName"`

ExportID string `json:"exportID"`

Kind string `json:"kind"`

SubKind string `json:"subKind"`

Name string `json:"name"`

Description string `json:"description"`

UserID string `json:"userID"`

ParentID string `json:"parentID"`

CreatedAt int64 `json:"createdAt"`

Resources []*Resource `json:"resources"`

}

type Resource struct {

ID string `json:"id"`

Kind string `json:"kind"`

Name string `json:"name"`

Deps []string `json:"deps"`

}

Page top