Files

Get Files

GET

https://openapi.niftypm.com

/api/v1.0/files

This endpoint fetch list of files based on the given query parameters.

Get Files › query Parameters

project_id

string · required

Project ID

task_id

string · required

Task ID

doc_id

string · required

Document ID

user_id

string · required

User ID

type

string

Type

limit

string

No of records per page

Example: 25

offset

string

Record Offset

Example: 0

folder_id

string

Folder ID

name

string

File Name

group

string

Group

tag

string

Tag

sort

string · enum

Sorting order, default is descending

Enum values:

ascending

descending

Get Files › Responses

Success Response

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

GET/api/v1.0/files

curl 'https://openapi.niftypm.com/api/v1.0/files?project_id=<string>&task_id=<string>&doc_id=<string>&user_id=<string>' \
  --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

Upload Files

POST

https://openapi.niftypm.com

/api/v1.0/files

This endpoint uploads multiples files.

Upload Files › query Parameters

project_id

string · required

Project ID

task_id

string · required

Task ID

doc_id

string · required

Document ID

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

Upload Files › Request Body

FilesUploadDto

files

string[] · application/octet-stream

It contains list of files path from local desktop to upload.

Upload Files › Responses

The resource created successfully

UploadFilesResponseDto

FileFullResponse[] · required

List of Label records

message

string

Success message

POST/api/v1.0/files

curl 'https://openapi.niftypm.com/api/v1.0/files?project_id=<string>&task_id=<string>&doc_id=<string>' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'files='

Example Request Body

{
  "files": [
    ""
  ]
}

text

Example Responses

{
  "message": "message",
  "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

Get File

GET

https://openapi.niftypm.com

/api/v1.0/files/{file_id}

This endpoint fetch the details of the file based on unique file identified

Get File › path Parameters

file_id

string · required

File ID

Get File › Responses

Success Response

FileFullResponse

id

string · required

name

string · required

size

number · required

url

string · required

download

string · required

thumbnail

string · required

uploader

string · required

comments

number · required

Number of comments

created_at

string · date-time · required

googleId

string · required

googleType

string · required

processed

boolean · required

task

string · required

Task

project_id

string · required

Project ID

message

string · required

Message

labels

string[] · required

List of labels

folder

string · required

folder

folder_stack

string[] · required

Folder path stack

document

string · required

Document

annotations_task_id

string · required

Annotation Task ID

Update File

PUT

https://openapi.niftypm.com

/api/v1.0/files/{file_id}

This endpoint update the file details.

Update File › path Parameters

file_id

string · required

File ID

Update File › Request Body

UpdateFile

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

annotations_task_id

string

Annotations Task ID

Update File › Responses

Success Response

UpdateFileResponse

message

string · required

Message

file_id

string · required

File ID

Remove File

DELETE

https://openapi.niftypm.com

/api/v1.0/files/{file_id}

This endpoint removes the file using the unique file idetifier.

Remove File › path Parameters

file_id

string · required

File ID

Remove File › Responses

Success Response

GeneralFileResponse

message

string · required

Success message

id

string · required

Created Label ID

Copy File

POST

https://openapi.niftypm.com

/api/v1.0/files/{file_id}/copy

This endpoint creates a new copy of the file.

Copy File › path Parameters

file_id

string · required

File ID

Copy File › Request Body

CopyFile

task_id

string · required

Task ID associated with the file

message_id

string · required

Message ID associated with the file

project_id

string · required

Project ID associated with the file

Copy File › Responses

The resource created successfully

No data returned

Add File Labels

PUT

https://openapi.niftypm.com

/api/v1.0/files/{file_id}/labels

This endpoint adds the labels for the file.

Add File Labels › path Parameters

file_id

string · required

File ID

Add File Labels › Request Body

UpdateLabels

labels

string[] · required

Labels

Add File Labels › Responses

Success Response

AddLabelsReponse

message

string · required

Message

labels

string[] · required

List of labels

Remove File Labels

DELETE

https://openapi.niftypm.com

/api/v1.0/files/{file_id}/labels

This endpoint remove the labels from the file.

Remove File Labels › path Parameters

file_id

string · required

File ID

Remove File Labels › Request Body

UpdateLabels

labels

string[] · required

Labels

Remove File Labels › Responses

Success Response

RemoveLabelsResponse

message

string · required

Message

labels

string[] · required

List of labels

Custom Fields Folders

Nifty API v1.0

Files

Get Files

GET

https://openapi.niftypm.com

/api/v1.0/files

This endpoint fetch list of files based on the given query parameters.

Get Files › query Parameters

project_id

string · required

Project ID

task_id

string · required

Task ID

doc_id

string · required

Document ID

user_id

string · required

User ID

type

string

Type

limit

string

No of records per page

Example: 25

offset

string

Record Offset

Example: 0

folder_id

string

Folder ID

name

string

File Name

group

string

Group

tag

string

Tag

sort

string · enum

Sorting order, default is descending

Enum values:

ascending

descending

Get Files › Responses

Success Response

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

GET/api/v1.0/files

curl 'https://openapi.niftypm.com/api/v1.0/files?project_id=<string>&task_id=<string>&doc_id=<string>&user_id=<string>' \
  --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

Upload Files

POST

https://openapi.niftypm.com

/api/v1.0/files

This endpoint uploads multiples files.

Upload Files › query Parameters

project_id

string · required

Project ID

task_id

string · required

Task ID

doc_id

string · required

Document ID

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

Upload Files › Request Body

FilesUploadDto

files

string[] · application/octet-stream

It contains list of files path from local desktop to upload.

Upload Files › Responses

The resource created successfully

UploadFilesResponseDto

FileFullResponse[] · required

List of Label records

message

string

Success message

POST/api/v1.0/files

curl 'https://openapi.niftypm.com/api/v1.0/files?project_id=<string>&task_id=<string>&doc_id=<string>' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer <token>' \
  --form 'files='

Example Request Body

{
  "files": [
    ""
  ]
}

text

Example Responses

{
  "message": "message",
  "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

Get File

GET

https://openapi.niftypm.com

/api/v1.0/files/{file_id}

This endpoint fetch the details of the file based on unique file identified

Get File › path Parameters

file_id

string · required

File ID

Get File › Responses

Success Response

FileFullResponse

id

string · required

name

string · required

size

number · required

url

string · required

download

string · required

thumbnail

string · required

uploader

string · required

comments

number · required

Number of comments

created_at

string · date-time · required

googleId

string · required

googleType

string · required

processed

boolean · required

task

string · required

Task

project_id

string · required

Project ID

message

string · required

Message

labels

string[] · required

List of labels

folder

string · required

folder

folder_stack

string[] · required

Folder path stack

document

string · required

Document

annotations_task_id

string · required

Annotation Task ID

Update File

PUT

https://openapi.niftypm.com

/api/v1.0/files/{file_id}

This endpoint update the file details.

Update File › path Parameters

file_id

string · required

File ID

Update File › Request Body

UpdateFile

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

annotations_task_id

string

Annotations Task ID

Update File › Responses

Success Response

UpdateFileResponse

message

string · required

Message

file_id

string · required

File ID

Remove File

DELETE

https://openapi.niftypm.com

/api/v1.0/files/{file_id}

This endpoint removes the file using the unique file idetifier.

Remove File › path Parameters

file_id

string · required

File ID

Remove File › Responses

Success Response

GeneralFileResponse

message

string · required

Success message

id

string · required

Created Label ID

Copy File

POST

https://openapi.niftypm.com

/api/v1.0/files/{file_id}/copy

This endpoint creates a new copy of the file.

Copy File › path Parameters

file_id

string · required

File ID

Copy File › Request Body

CopyFile

task_id

string · required

Task ID associated with the file

message_id

string · required

Message ID associated with the file

project_id

string · required

Project ID associated with the file

Copy File › Responses

The resource created successfully

No data returned

Add File Labels

PUT

https://openapi.niftypm.com

/api/v1.0/files/{file_id}/labels

This endpoint adds the labels for the file.

Add File Labels › path Parameters

file_id

string · required

File ID

Add File Labels › Request Body

UpdateLabels

labels

string[] · required

Labels

Add File Labels › Responses

Success Response

AddLabelsReponse

message

string · required

Message

labels

string[] · required

List of labels

Remove File Labels

DELETE

https://openapi.niftypm.com

/api/v1.0/files/{file_id}/labels

This endpoint remove the labels from the file.

Remove File Labels › path Parameters

file_id

string · required

File ID

Remove File Labels › Request Body

UpdateLabels

labels

string[] · required

Labels

Remove File Labels › Responses

Success Response

RemoveLabelsResponse

message

string · required

Message

labels

string[] · required

List of labels

Custom Fields Folders