Back to Apitable

.InternalServiceDataTableFieldPermissionInterfaceApi

packages/api-client/InternalServiceDataTableFieldPermissionInterfaceApi.md

1.13.0-beta.15.2 KB
Original Source

.InternalServiceDataTableFieldPermissionInterfaceApi

All URIs are relative to http://backend/api/v1

MethodHTTP requestDescription
disableRolesPOST /internal/datasheet/{dstId}/field/permission/disableturn off multiple field permissions
getFieldPermissionGET /internal/node/{nodeId}/field/permissionget field permissions
getMultiFieldPermissionViewsPOST /internal/node/field/permissionget field permission set for multiple nodes

disableRoles

ResponseDataVoid disableRoles()

room layer ot delete field operation call

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .InternalServiceDataTableFieldPermissionInterfaceApi(configuration);

let body:.InternalServiceDataTableFieldPermissionInterfaceApiDisableRolesRequest = {
  // string | table id
  dstId: "dstGxznHFXf9pvF1LZ",
  // string | list of field ids
  fieldIds: "fldB7uWmwYrQf,fldB7uWmwYrQf",
};

apiInstance.disableRoles(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
dstId[string]table iddefaults to undefined
fieldIds[string]list of field idsdefaults to undefined

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

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

getFieldPermission

ResponseDataFieldPermissionView getFieldPermission()

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .InternalServiceDataTableFieldPermissionInterfaceApi(configuration);

let body:.InternalServiceDataTableFieldPermissionInterfaceApiGetFieldPermissionRequest = {
  // string | node id
  nodeId: "dstCgcfixAKyeeNsaP",
  // string | user id
  userId: "123",
  // string | share id (optional)
  shareId: "shrFPXT8qnyFJglX6elJi",
};

apiInstance.getFieldPermission(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
nodeId[string]node iddefaults to undefined
userId[string]user iddefaults to undefined
shareId[string]share id(optional) defaults to undefined

Return type

ResponseDataFieldPermissionView

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

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

getMultiFieldPermissionViews

ResponseDataListFieldPermissionView getMultiFieldPermissionViews(internalPermissionRo)

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .InternalServiceDataTableFieldPermissionInterfaceApi(configuration);

let body:.InternalServiceDataTableFieldPermissionInterfaceApiGetMultiFieldPermissionViewsRequest = {
  // InternalPermissionRo
  internalPermissionRo: {
    nodeIds: ["fomtujwf5eSWKiMaVw","dstbw4CZFURbchgP17"],
    shareId: "shr8T8vAfehg3yj3McmDG",
    userId: "usrddddd",
  },
};

apiInstance.getMultiFieldPermissionViews(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
internalPermissionRoInternalPermissionRo

Return type

ResponseDataListFieldPermissionView

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

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