Skip to content

Latest commit

 

History

History
137 lines (93 loc) · 4.98 KB

ObjectPermissionAPI.md

File metadata and controls

137 lines (93 loc) · 4.98 KB
Raw

ObjectPermissionAPI

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
ObjectPermissionAPI_permissionCreateObjectV1 POST /1/object/permission Create a new Permission
ObjectPermissionAPI_permissionDeleteObjectV1 DELETE /1/object/permission/{pkiPermissionID} Delete an existing Permission
ObjectPermissionAPI_permissionEditObjectV1 PUT /1/object/permission/{pkiPermissionID} Edit an existing Permission
ObjectPermissionAPI_permissionGetObjectV2 GET /2/object/permission/{pkiPermissionID} Retrieve an existing Permission

ObjectPermissionAPI_permissionCreateObjectV1

// Create a new Permission
//
// The endpoint allows to create one or many elements at once.
//
permission_create_object_v1_response_t* ObjectPermissionAPI_permissionCreateObjectV1(apiClient_t *apiClient, permission_create_object_v1_request_t *permission_create_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
permission_create_object_v1_request permission_create_object_v1_request_t *

Return type

permission_create_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectPermissionAPI_permissionDeleteObjectV1

// Delete an existing Permission
//
// 
//
permission_delete_object_v1_response_t* ObjectPermissionAPI_permissionDeleteObjectV1(apiClient_t *apiClient, int *pkiPermissionID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiPermissionID int * The unique ID of the Permission

Return type

permission_delete_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectPermissionAPI_permissionEditObjectV1

// Edit an existing Permission
//
// 
//
permission_edit_object_v1_response_t* ObjectPermissionAPI_permissionEditObjectV1(apiClient_t *apiClient, int *pkiPermissionID, permission_edit_object_v1_request_t *permission_edit_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiPermissionID int * The unique ID of the Permission
permission_edit_object_v1_request permission_edit_object_v1_request_t *

Return type

permission_edit_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectPermissionAPI_permissionGetObjectV2

// Retrieve an existing Permission
//
// 
//
permission_get_object_v2_response_t* ObjectPermissionAPI_permissionGetObjectV2(apiClient_t *apiClient, int *pkiPermissionID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiPermissionID int * The unique ID of the Permission

Return type

permission_get_object_v2_response_t *

Authorization

Authorization

HTTP request headers

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

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