Skip to content

Latest commit

 

History

History
executable file
·
320 lines (197 loc) · 9.14 KB

DataManagerApi.md

File metadata and controls

executable file
·
320 lines (197 loc) · 9.14 KB

\DataManagerApi

All URIs are relative to http://api.labelstud.io

Method HTTP request Description
ApiDmActionsCreate Post /api/dm/actions/ Post actions
ApiDmActionsList Get /api/dm/actions/ Get actions
ApiDmColumnsList Get /api/dm/columns/ Get data manager columns
ApiDmProjectList Get /api/dm/project/ Get project state
ApiDmViewsCreate Post /api/dm/views/ Create view
ApiDmViewsDelete Delete /api/dm/views/{id}/ Delete view
ApiDmViewsList Get /api/dm/views/ List views
ApiDmViewsPartialUpdate Patch /api/dm/views/{id}/ Update view
ApiDmViewsRead Get /api/dm/views/{id}/ Get view details
ApiDmViewsReset Delete /api/dm/views/reset/ Reset project views
ApiDmViewsUpdate Put /api/dm/views/{id}/ Put view

ApiDmActionsCreate

ApiDmActionsCreate(ctx, ) Post actions

Perform an action with the selected items from a specific view.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmActionsList

ApiDmActionsList(ctx, ) Get actions

Retrieve all the registered actions with descriptions that data manager can use.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmColumnsList

ApiDmColumnsList(ctx, ) Get data manager columns

Retrieve the data manager columns available for the tasks in a specific project.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmProjectList

ApiDmProjectList(ctx, ) Get project state

Retrieve the project state for the data manager.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmViewsCreate

View ApiDmViewsCreate(ctx, data) Create view

Create a view for a specific project.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
data View

Return type

View

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmViewsDelete

ApiDmViewsDelete(ctx, id) Delete view

Delete a specific view by ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string View ID

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmViewsList

[]View ApiDmViewsList(ctx, optional) List views

List all views for a specific project.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DataManagerApiApiDmViewsListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DataManagerApiApiDmViewsListOpts struct

Name Type Description Notes
project optional.Int32 Project ID

Return type

[]View

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmViewsPartialUpdate

View ApiDmViewsPartialUpdate(ctx, data, id) Update view

Update view data with additional filters and other information for a specific project.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
data View
id string View ID

Return type

View

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmViewsRead

View ApiDmViewsRead(ctx, id) Get view details

Get the details about a specific view in the data manager

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string View ID

Return type

View

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmViewsReset

ApiDmViewsReset(ctx, data) Reset project views

Reset all views for a specific project.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
data ViewReset

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiDmViewsUpdate

View ApiDmViewsUpdate(ctx, data, id) Put view

Overwrite view data with updated filters and other information for a specific project.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
data View
id string View ID

Return type

View

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]