fimidara — docs

`FimidaraEndpoints.resources.getResources`

Parameters

props—Required

{

authToken: string

body: GetResourcesEndpointParams

}

GetResourcesEndpointParams

—Optional

{

workspaceId?: string

resources: Array<FetchResourceItem>

}

FetchResourceItem

—Optional

{

resourceId?: string | Array<string>

action: string

filepath?: string | Array<string>

folderpath?: string | Array<string>

workspaceRootname?: string

}

Result

—Optional

{

headers: Headers

body?: GetResourcesEndpointResult

}

GetResourcesEndpointResult

—Optional

{

resources: Array<ResourceWrapper>

}

ResourceWrapper

—Optional

{

resourceId: string

resourceType: string

resource: Resource

}

Resource

—Optional

Resource shape depends on resource type

{

resourceId: string

createdBy?: Agent

createdAt: number

lastUpdatedBy?: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

}

Agent

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

name: string

message: string

field?: string

}

`FimidaraEndpoints.resources.getResources`

Parameters

props—Required

{

authToken: string

body: GetResourcesEndpointParams

}

GetResourcesEndpointParams

—Optional

{

workspaceId?: string

resources: Array<FetchResourceItem>

}

FetchResourceItem

—Optional

{

resourceId?: string | Array<string>

action: string

filepath?: string | Array<string>

folderpath?: string | Array<string>

workspaceRootname?: string

}

Result

—Optional

{

headers: Headers

body?: GetResourcesEndpointResult

}

GetResourcesEndpointResult

—Optional

{

resources: Array<ResourceWrapper>

}

ResourceWrapper

—Optional

{

resourceId: string

resourceType: string

resource: Resource

}

Resource

—Optional

Resource shape depends on resource type

{

resourceId: string

createdBy?: Agent

createdAt: number

lastUpdatedBy?: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

}

Agent

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

name: string

message: string

field?: string

}

FimidaraEndpoints.resources.getResources

Parameters

GetResourcesEndpointParams

FetchResourceItem

Result

GetResourcesEndpointResult

ResourceWrapper

Resource

Agent

Throws

FimidaraEndpointErrorItem

Loading...

FimidaraEndpoints.resources.getResources

Parameters

GetResourcesEndpointParams

FetchResourceItem

Result

GetResourcesEndpointResult

ResourceWrapper

Resource

Agent

Throws

FimidaraEndpointErrorItem

`FimidaraEndpoints.resources.getResources`

`FimidaraEndpoints.resources.getResources`