PLplugsign

GET Single folder

Changed on

Com este endpoint você pode visualizar uma única pasta do sistema.

Com paginate_sub_folders ativo a resposta muda de formato: vem folder (a pasta) e sub_folders (paginador padrão do Laravel com os registros das subpastas). Sem ele, a resposta é data com a pasta e sub_folders: [].

get/api/folders/{idFolder}

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/folders/{idFolder}
  • Auth
    API key in header Authorization

Path parameters

idFolderinteger required

ID numérico da pasta.

Query parameters

paginate_sub_folders'1' | '0' | 'true' | 'false'

Quando ativo (true, 1, on ou yes), devolve as subpastas paginadas no segundo formato de resposta. Use false ou 0 para desativar.

per_pageinteger

Quantidade de subpastas por página quando paginate_sub_folders está ativo. Padrão: 15.

Response

Pasta encontrada. Veja os dois formatos nos exemplos.

Example response

{
  "data": {
    "id": 1,
    "folder": "public_folder",
    "accessibility": "Everyone",
    "created_on": "26/11/2024 14:24:25"
  }
}

Changes

  • 3db1513040eaRevision changes
    • breaking

      the query request parameter paginate_sub_folders was restricted to a list of enum values

    • breaking

      for the path request parameter idFolder, the type changed from string to integer

    • warning

      added the new Only Me enum value to the / response property for the response status

    • info

      added the new optional query request parameter per_page

    • info

      added the new enum value 0 to the query request parameter paginate_sub_folders

    • info

      added the new enum value 1 to the query request parameter paginate_sub_folders

    • info

      added the new enum value false to the query request parameter paginate_sub_folders

    • info

      added the new enum value true to the query request parameter paginate_sub_folders

    • info

      for the query request parameter paginate_sub_folders, the type was generalized from boolean to string

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the OnlyMe enum value from the / response property for the response status