Folders

Get Folder Children

GET

https://openapi.niftypm.com

/api/v2.0/folders

This endpoint fetch list of sub folders of the folder based on the given query parameters.

Get Folder Children › query Parameters

project_id

string · required

Project Id

folder_id

string · required

Folder Id

limit

number · required

No of records per page

Example: 25

offset

number · required

Record Offset

Example: 0

Get Folder Children › Responses

Success Response

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

GET/api/v2.0/folders

curl 'https://openapi.niftypm.com/api/v2.0/folders?project_id=<string>&folder_id=<string>&limit=<number>&offset=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "hasMore": false,
  "files": [
    {
      "id": "id",
      "name": "name",
      "size": 0,
      "url": "url",
      "download": "download",
      "thumbnail": "thumbnail",
      "uploader": "uploader",
      "comments": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "googleId": "googleId",
      "googleType": "googleType",
      "processed": true,
      "task": "task",
      "project_id": "project_id",
      "message": "message",
      "labels": [
        "string"
      ],
      "folder": "folder",
      "folder_stack": [
        "string"
      ],
      "document": "document",
      "annotations_task_id": "annotations_task_id"
    }
  ]
}

json

application/json

Add Folder

POST

https://openapi.niftypm.com

/api/v2.0/folders

This endpoint adds new folder in the project.

Add Folder › Request Body

CreateFolderDTO

project_id

string · required

Project ID

folder_name

string · required

Folder name

type

string · required

Type

parent_folder

string · required

Parent Folder Id

folder_stack

string[] · required

Folder stack

Add Folder › Responses

Success Response

FolderResponse

Get Folder

GET

https://openapi.niftypm.com

/api/v2.0/folders/{folderId}

This endpoint fetch particular folder based on the given query parameter.

Get Folder › path Parameters

folderId

string · required

Get Folder › Responses

Success Response

FolderResponse

PUT

https://openapi.niftypm.com

/api/v2.0/folders/{folderId}

path Parameters

folderId

string · required

Request Body

UpdateFolderDTO

name

string · required

Folder name

parent_folder

string · required

Parent Folder Id

folder_stack

string[] · required

Folder stack

Responses

Success Response

UpdateFolderResponse

success

boolean · required

Success

folder

object · required

Folder Id

Remove Folder

DELETE

https://openapi.niftypm.com

/api/v2.0/folders/{folderId}

This endpoint removes the folder using the unique folder idetifier.

Remove Folder › path Parameters

folder_id

string · required

Folder ID

Remove Folder › Responses

Success Response

No data returned

Get Folder Conntents

GET

https://openapi.niftypm.com

/api/v2.0/folders/content

This endpoint fetch folder contents based on the given query parameters.

Get Folder Conntents › query Parameters

project_id

string · required

Project Id

folder_id

string · required

Folder Id

limit

number · required

No of records per page

Example: 25

offset

number · required

Record Offset

Example: 0

Get Folder Conntents › Responses

Success Response

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

GET/api/v2.0/folders/content

curl 'https://openapi.niftypm.com/api/v2.0/folders/content?project_id=<string>&folder_id=<string>&limit=<number>&offset=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "hasMore": false,
  "files": [
    {
      "id": "id",
      "name": "name",
      "size": 0,
      "url": "url",
      "download": "download",
      "thumbnail": "thumbnail",
      "uploader": "uploader",
      "comments": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "googleId": "googleId",
      "googleType": "googleType",
      "processed": true,
      "task": "task",
      "project_id": "project_id",
      "message": "message",
      "labels": [
        "string"
      ],
      "folder": "folder",
      "folder_stack": [
        "string"
      ],
      "document": "document",
      "annotations_task_id": "annotations_task_id"
    }
  ]
}

json

application/json

Files Invite

Nifty API v1.0

Folders

Get Folder Children

GET

https://openapi.niftypm.com

/api/v2.0/folders

This endpoint fetch list of sub folders of the folder based on the given query parameters.

Get Folder Children › query Parameters

project_id

string · required

Project Id

folder_id

string · required

Folder Id

limit

number · required

No of records per page

Example: 25

offset

number · required

Record Offset

Example: 0

Get Folder Children › Responses

Success Response

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

GET/api/v2.0/folders

curl 'https://openapi.niftypm.com/api/v2.0/folders?project_id=<string>&folder_id=<string>&limit=<number>&offset=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "hasMore": false,
  "files": [
    {
      "id": "id",
      "name": "name",
      "size": 0,
      "url": "url",
      "download": "download",
      "thumbnail": "thumbnail",
      "uploader": "uploader",
      "comments": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "googleId": "googleId",
      "googleType": "googleType",
      "processed": true,
      "task": "task",
      "project_id": "project_id",
      "message": "message",
      "labels": [
        "string"
      ],
      "folder": "folder",
      "folder_stack": [
        "string"
      ],
      "document": "document",
      "annotations_task_id": "annotations_task_id"
    }
  ]
}

json

application/json

Add Folder

POST

https://openapi.niftypm.com

/api/v2.0/folders

This endpoint adds new folder in the project.

Add Folder › Request Body

CreateFolderDTO

project_id

string · required

Project ID

folder_name

string · required

Folder name

type

string · required

Type

parent_folder

string · required

Parent Folder Id

folder_stack

string[] · required

Folder stack

Add Folder › Responses

Success Response

FolderResponse

Get Folder

GET

https://openapi.niftypm.com

/api/v2.0/folders/{folderId}

This endpoint fetch particular folder based on the given query parameter.

Get Folder › path Parameters

folderId

string · required

Get Folder › Responses

Success Response

FolderResponse

PUT

https://openapi.niftypm.com

/api/v2.0/folders/{folderId}

path Parameters

folderId

string · required

Request Body

UpdateFolderDTO

name

string · required

Folder name

parent_folder

string · required

Parent Folder Id

folder_stack

string[] · required

Folder stack

Responses

Success Response

UpdateFolderResponse

success

boolean · required

Success

folder

object · required

Folder Id

Remove Folder

DELETE

https://openapi.niftypm.com

/api/v2.0/folders/{folderId}

This endpoint removes the folder using the unique folder idetifier.

Remove Folder › path Parameters

folder_id

string · required

Folder ID

Remove Folder › Responses

Success Response

No data returned

Get Folder Conntents

GET

https://openapi.niftypm.com

/api/v2.0/folders/content

This endpoint fetch folder contents based on the given query parameters.

Get Folder Conntents › query Parameters

project_id

string · required

Project Id

folder_id

string · required

Folder Id

limit

number · required

No of records per page

Example: 25

offset

number · required

Record Offset

Example: 0

Get Folder Conntents › Responses

Success Response

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

GET/api/v2.0/folders/content

curl 'https://openapi.niftypm.com/api/v2.0/folders/content?project_id=<string>&folder_id=<string>&limit=<number>&offset=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "hasMore": false,
  "files": [
    {
      "id": "id",
      "name": "name",
      "size": 0,
      "url": "url",
      "download": "download",
      "thumbnail": "thumbnail",
      "uploader": "uploader",
      "comments": 0,
      "created_at": "2024-08-25T15:00:00Z",
      "googleId": "googleId",
      "googleType": "googleType",
      "processed": true,
      "task": "task",
      "project_id": "project_id",
      "message": "message",
      "labels": [
        "string"
      ],
      "folder": "folder",
      "folder_stack": [
        "string"
      ],
      "document": "document",
      "annotations_task_id": "annotations_task_id"
    }
  ]
}

json

application/json

Files Invite