Folders

>>>

GET /api/v2/folders
List of media_folders

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "my_folders": 54,
  "shared_folders": null,
  "stock_folders": 49,
  "content_request": 1
}
>>>

GET /api/v2/folders/:id
Show media_folder

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 1,
  "name": "Stock folder",
  "elements_count": 0,
  "ancestors": [],
  "folders": [
    {
      "id": 2,
      "name": "Folder in folder",
      "children_exist": false,
      "user": {
        "id": 11,
        "email": "kruchina.vadim+2@gmail.com",
        "first_name": null,
        "last_name": "Stone",
        "avatar_image": null
      }
    },
    ...
  ],
  "user": {
    "id": 11,
    "email": "kruchina.vadim+2@gmail.com",
    "first_name": null,
    "last_name": "Stone",
    "avatar_image": null
  }
}

Params

Param name Description
id
required

ID of media folder

Validations:

  • Must be a Integer
sort_by
optional

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
>>>

POST /api/v2/folders
Create media_folder

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "folder": {
    "name": "Postman folder"
    "ancestry": "64"
  }
}

Success response body ↑

{
  "id": 65,
  "name": "Postman folder"
}

Params

Param name Description
folder
required

Validations:

  • Must be a Hash
folder[name]
required

Name of media folder

Validations:

  • Must be a String
folder[ancestry]
optional

ID of parrent folder

Validations:

  • Must be a String
>>>

PUT /api/v2/folders/:id
Update media_folder

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "folder": {
    "name": "Updated Postman folder"
  }
}

Success response body ↑

{
  "id": 65,
  "name": "Updated Postman folder"
}

Params

Param name Description
id
required

ID of media folder

Validations:

  • Must be a Integer
folder
required

Validations:

  • Must be a Hash
folder[name]
required

Name of media folder

Validations:

  • Must be a String
folder[ancestry]
required

ID of parrent folder

Validations:

  • Must be a String
>>>

DELETE /api/v2/folders/:id
Delete media_folder

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}
>>>

POST /api/v2/folders/:id/share_with_team
Share with team

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "team_ids": [1, ...]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

ID of folder

Validations:

  • Must be a Integer
team_ids
required

Array of Team IDs

Validations:

  • Must be an array of Integer
>>>

POST /api/v2/folders/bulk_share_with_team
bulk share with team

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "media_file_ids": [1, 2, ...]
  "folder_ids": [2, 5, 6, ...]
  "team_ids": [1, 2, ...]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
media_file_ids
optional

Validations:

  • Must be an array of Integer
folder_ids
optional

Validations:

  • Must be an array of Integer
team_ids
required

Validations:

  • Must be an array of Integer
>>>

PUT /api/v2/folders/move
Move folder to other folder

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "folder_ids": [1, 2, ...],
  "folder": {
    "ancestry": "5"
  }
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
folder_ids
required

Array of IDs of folders should be moved

Validations:

  • Must be an array of Integer
folder
required

Validations:

  • Must be a Hash
folder[ancestry]
required , nil allowed

Id of parant folder

Validations:

  • Must be a String
>>>

DELETE /api/v2/folders/bulk_destroy
Delete folders

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "folder_ids": [1, ...],
  "media_file_ids: [43, ...]
}

Success response body ↑

{
  "success": true
}

Params

Param name Description
folder_ids
required

Array of IDs of folders should be deleted

Validations:

  • Must be an array of Integer
media_file_ids
required

Array of IDs of media files should be deleted

Validations:

  • Must be an array of Integer