Skip to content

CustomObjectsAPI.md

Latest commit

 

History

History
148 lines (93 loc) · 4.29 KB

CustomObjectsAPI.md

File metadata and controls

148 lines (93 loc) · 4.29 KB

\CustomObjectsAPI

All URIs are relative to https://api.eduframe.nl/api/v1

Method HTTP request Description
GetCustomObjectByObjectId Get /custom/objects/{object_id} Get a custom object by object_id
GetCustomObjects Get /custom/objects Get all custom objects

GetCustomObjectByObjectId

CustomObjectWithFields GetCustomObjectByObjectId(ctx, objectId).Execute()

Get a custom object by object_id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	objectId := int32(56) // int32 | The unique identifier of the custom object. 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
objectId int32 The unique identifier of the custom object.

Other Parameters

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

Name Type Description Notes

Return type

CustomObjectWithFields

Authorization

Bearer

HTTP request headers

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

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

GetCustomObjects

[]CustomObject GetCustomObjects(ctx).Cursor(cursor).PerPage(perPage).Execute()

Get all custom objects

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	cursor := "cursor_example" // string | **Note**: It's almost never necessary to use this parameter directly, the URL   should be retrieved from the `Link` header.  The cursor used to fetch the next result set.  (optional)
	perPage := int32(10) // int32 | The number of results to retrieve for this page. (optional) (default to 25)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CustomObjectsAPI.GetCustomObjects(context.Background()).Cursor(cursor).PerPage(perPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CustomObjectsAPI.GetCustomObjects``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetCustomObjects`: []CustomObject
	fmt.Fprintf(os.Stdout, "Response from `CustomObjectsAPI.GetCustomObjects`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
cursor string Note: It's almost never necessary to use this parameter directly, the URL should be retrieved from the `Link` header. The cursor used to fetch the next result set.
perPage int32 The number of results to retrieve for this page. [default to 25]

Return type

[]CustomObject

Authorization

Bearer

HTTP request headers

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

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