\FunctionsApi

All URIs are relative to https://chaos.qernal.com/v1

Method	HTTP request	Description
functions_create	POST /functions	Create function
functions_delete	DELETE /functions/{function_id}	Delete function
functions_get	GET /functions/{function_id}	Get function (latest revision)
functions_revisions_get	GET /functions/{function_id}/revisions/{function_revision_id}	Get a specific revision of a function
functions_revisions_list	GET /functions/{function_id}/revisions	List all revisions for a function
functions_update	PUT /functions/{function_id}	Update function
projects_functions_list	GET /projects/{project_id}/functions	List all functions within a project

functions_create

models::Function functions_create(function_body) Create function

Create a new function

Parameters

Name	Type	Description	Required	Notes
function_body	FunctionBody	Create/Update any field	[required]

Return type

models::Function

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]

functions_delete

models::DeletedResponse functions_delete(function_id) Delete function

Delete a function (and all revisions)

Parameters

Name	Type	Description	Required	Notes
function_id	uuid::Uuid	Function ID reference	[required]

Return type

models::DeletedResponse

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]

functions_get

models::Function functions_get(function_id) Get function (latest revision)

Get a specific function (latest revision)

Parameters

Name	Type	Description	Required	Notes
function_id	uuid::Uuid	Function ID reference	[required]

Return type

models::Function

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]

functions_revisions_get

models::Function functions_revisions_get(function_id, function_revision_id) Get a specific revision of a function

Get a specific revision of a function

Parameters

Name	Type	Description	Required	Notes
function_id	uuid::Uuid	Function ID reference	[required]
function_revision_id	uuid::Uuid	Function revision ID reference	[required]

Return type

models::Function

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]

functions_revisions_list

models::ListFunction functions_revisions_list(function_id, page) List all revisions for a function

List all revisions for a function

Parameters

Name	Type	Description	Required	Notes
function_id	uuid::Uuid	Function ID reference	[required]
page	Option<OrganisationsListPageParameter>	Query parameters for pagination

Return type

models::ListFunction

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]

functions_update

models::Function functions_update(function_id, function) Update function

Update a function (creates a new revision)

Parameters

Name	Type	Description	Required	Notes
function_id	uuid::Uuid	Function ID reference	[required]
function	Function	Update any field	[required]

Return type

models::Function

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]

projects_functions_list

models::ListFunction projects_functions_list(project_id, page) List all functions within a project

List all functions

Parameters

Name	Type	Description	Required	Notes
project_id	uuid::Uuid	Project ID reference	[required]
page	Option<OrganisationsListPageParameter>	Query parameters for pagination

Return type

models::ListFunction

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]