fimidara — docs

`/v1/folders/addFolder`

—

`post`

Path Parameters

Not Applicable

Request Headers

HttpEndpointRequestHeaders_AuthRequired_JsonContentType

—Optional

Field	Type	Required	Description
`Authorization`	`string`	Yes	Access token Example: Bearer <token>
`Content-Type`	`string`	Yes	HTTP JSON request content type Example: application/json

Request Query

Not Applicable

Request Body

AddFolderEndpointParams

—Optional

{

description?: string

folderpath: string

}

200 — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	HTTP JSON response content type Example: application/json
`Content-Length`	`string`	Yes	HTTP response content length in bytes

200 — Response Body

AddFolderEndpointResult

—Optional

{

folder: Folder

notes?: Array<EndpointResultNote>

}

Folder

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

description?: string

idPath: Array<string>

namepath: Array<string>

parentId: string | null

}

Agent

—Optional

{

agentId: string

agentType: string

}

EndpointResultNote

—Optional

{

code: string

message: string

}

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	HTTP JSON response content type Example: application/json
`Content-Length`	`string`	Yes	HTTP response content length in bytes

4XX or 5XX — Response Body

EndpointErrorResult

—Optional

Endpoint error result

{

errors?: Array<OperationError>

}

OperationError

—Optional

{

message: string

action?: string

field?: string

notes?: Array<EndpointResultNote>

}

EndpointResultNote

—Optional

{

code: string

message: string

}

`/v1/folders/addFolder`

—

`post`

Path Parameters

Not Applicable

Request Headers

HttpEndpointRequestHeaders_AuthRequired_JsonContentType

—Optional

Field	Type	Required	Description
`Authorization`	`string`	Yes	Access token Example: Bearer <token>
`Content-Type`	`string`	Yes	HTTP JSON request content type Example: application/json

Request Query

Not Applicable

Request Body

AddFolderEndpointParams

—Optional

{

description?: string

folderpath: string

}

200 — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	HTTP JSON response content type Example: application/json
`Content-Length`	`string`	Yes	HTTP response content length in bytes

200 — Response Body

AddFolderEndpointResult

—Optional

{

folder: Folder

notes?: Array<EndpointResultNote>

}

Folder

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

description?: string

idPath: Array<string>

namepath: Array<string>

parentId: string | null

}

Agent

—Optional

{

agentId: string

agentType: string

}

EndpointResultNote

—Optional

{

code: string

message: string

}

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	HTTP JSON response content type Example: application/json
`Content-Length`	`string`	Yes	HTTP response content length in bytes

4XX or 5XX — Response Body

EndpointErrorResult

—Optional

Endpoint error result

{

errors?: Array<OperationError>

}

OperationError

—Optional

{

message: string

action?: string

field?: string

notes?: Array<EndpointResultNote>

}

EndpointResultNote

—Optional

{

code: string

message: string

}

/v1/folders/addFolder

post

Path Parameters

Not Applicable

Request Headers

HttpEndpointRequestHeaders_AuthRequired_JsonContentType

Request Query

Not Applicable

Request Body

AddFolderEndpointParams

200 — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

200 — Response Body

AddFolderEndpointResult

Folder

Agent

EndpointResultNote

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

4XX or 5XX — Response Body

EndpointErrorResult

OperationError

EndpointResultNote

Loading...

/v1/folders/addFolder

post

Path Parameters

Not Applicable

Request Headers

HttpEndpointRequestHeaders_AuthRequired_JsonContentType

Request Query

Not Applicable

Request Body

AddFolderEndpointParams

200 — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

200 — Response Body

AddFolderEndpointResult

Folder

Agent

EndpointResultNote

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

4XX or 5XX — Response Body

EndpointErrorResult

OperationError

EndpointResultNote

`/v1/folders/addFolder`

`post`

`/v1/folders/addFolder`

`post`