Skip to content

Latest commit

 

History

History
290 lines (183 loc) · 8.76 KB

ObjectPermissionAPI.md

File metadata and controls

290 lines (183 loc) · 8.76 KB
Raw

eZmaxAPI\ObjectPermissionAPI

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

Method HTTP request Description
PermissionCreateObjectV1 Post /1/object/permission Create a new Permission
PermissionDeleteObjectV1 Delete /1/object/permission/{pkiPermissionID} Delete an existing Permission
PermissionEditObjectV1 Put /1/object/permission/{pkiPermissionID} Edit an existing Permission
PermissionGetObjectV2 Get /2/object/permission/{pkiPermissionID} Retrieve an existing Permission

PermissionCreateObjectV1

PermissionCreateObjectV1Response PermissionCreateObjectV1(ctx).PermissionCreateObjectV1Request(permissionCreateObjectV1Request).Execute()

Create a new Permission

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	permissionCreateObjectV1Request := *openapiclient.NewPermissionCreateObjectV1Request([]openapiclient.PermissionRequestCompound{*openapiclient.NewPermissionRequestCompound(int32(53))}) // PermissionCreateObjectV1Request | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectPermissionAPI.PermissionCreateObjectV1(context.Background()).PermissionCreateObjectV1Request(permissionCreateObjectV1Request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectPermissionAPI.PermissionCreateObjectV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PermissionCreateObjectV1`: PermissionCreateObjectV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectPermissionAPI.PermissionCreateObjectV1`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPermissionCreateObjectV1Request struct via the builder pattern

Name Type Description Notes
permissionCreateObjectV1Request PermissionCreateObjectV1Request

Return type

PermissionCreateObjectV1Response

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]

PermissionDeleteObjectV1

PermissionDeleteObjectV1Response PermissionDeleteObjectV1(ctx, pkiPermissionID).Execute()

Delete an existing Permission

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiPermissionID := int32(56) // int32 | The unique ID of the Permission

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectPermissionAPI.PermissionDeleteObjectV1(context.Background(), pkiPermissionID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectPermissionAPI.PermissionDeleteObjectV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PermissionDeleteObjectV1`: PermissionDeleteObjectV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectPermissionAPI.PermissionDeleteObjectV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiPermissionID int32 The unique ID of the Permission

Other Parameters

Other parameters are passed through a pointer to a apiPermissionDeleteObjectV1Request struct via the builder pattern

Name Type Description Notes

Return type

PermissionDeleteObjectV1Response

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]

PermissionEditObjectV1

PermissionEditObjectV1Response PermissionEditObjectV1(ctx, pkiPermissionID).PermissionEditObjectV1Request(permissionEditObjectV1Request).Execute()

Edit an existing Permission

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiPermissionID := int32(56) // int32 | The unique ID of the Permission
	permissionEditObjectV1Request := *openapiclient.NewPermissionEditObjectV1Request(*openapiclient.NewPermissionRequestCompound(int32(53))) // PermissionEditObjectV1Request | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectPermissionAPI.PermissionEditObjectV1(context.Background(), pkiPermissionID).PermissionEditObjectV1Request(permissionEditObjectV1Request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectPermissionAPI.PermissionEditObjectV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PermissionEditObjectV1`: PermissionEditObjectV1Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectPermissionAPI.PermissionEditObjectV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiPermissionID int32 The unique ID of the Permission

Other Parameters

Other parameters are passed through a pointer to a apiPermissionEditObjectV1Request struct via the builder pattern

Name Type Description Notes

permissionEditObjectV1Request | PermissionEditObjectV1Request | |

Return type

PermissionEditObjectV1Response

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]

PermissionGetObjectV2

PermissionGetObjectV2Response PermissionGetObjectV2(ctx, pkiPermissionID).Execute()

Retrieve an existing Permission

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/ezmaxinc/ezmax-sdk-go"
)

func main() {
	pkiPermissionID := int32(56) // int32 | The unique ID of the Permission

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ObjectPermissionAPI.PermissionGetObjectV2(context.Background(), pkiPermissionID).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObjectPermissionAPI.PermissionGetObjectV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PermissionGetObjectV2`: PermissionGetObjectV2Response
	fmt.Fprintf(os.Stdout, "Response from `ObjectPermissionAPI.PermissionGetObjectV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiPermissionID int32 The unique ID of the Permission

Other Parameters

Other parameters are passed through a pointer to a apiPermissionGetObjectV2Request struct via the builder pattern

Name Type Description Notes

Return type

PermissionGetObjectV2Response

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]