Skip to content

Latest commit

 

History

History
193 lines (121 loc) · 6.08 KB

File metadata and controls

193 lines (121 loc) · 6.08 KB

{{classname}}

All URIs are relative to /api

Method HTTP request Description
CreateLog Post /logs Adds a new log
GetLogAttachment Get /logs/{logId}/attachments/{attachmentId} Get one specific attachment associated with a log
GetLogById Get /logs/{logId} Gets a log by Id
GetLogTree Get /logs/{logId}/tree Get the Log tree for a given Log
ListLogAttachments Get /logs/{logId}/attachments Get all attachments associated with a log
ListLogs Get /logs List all logs
ListTagsByLogId Get /logs/{logId}/tags Lists all tags associated with a log

CreateLog

LogResponse CreateLog(ctx, body) Adds a new log

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CreateLog

Return type

LogResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetLogAttachment

AttachmentResponse GetLogAttachment(ctx, logId, attachmentId) Get one specific attachment associated with a log

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
logId int64 The id of the log to retrieve
attachmentId int64 The id of the attached to retrieve

Return type

AttachmentResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetLogById

LogResponse GetLogById(ctx, logId) Gets a log by Id

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
logId int64 The id of the log to retrieve

Return type

LogResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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

GetLogTree

LogTreeResponse GetLogTree(ctx, logId) Get the Log tree for a given Log

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
logId int64 The id of the log to retrieve

Return type

LogTreeResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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

ListLogAttachments

ArrayOfAttachmentsResponse ListLogAttachments(ctx, logId) Get all attachments associated with a log

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
logId int64 The id of the log to retrieve

Return type

ArrayOfAttachmentsResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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

ListLogs

ArrayOfLogsResponse ListLogs(ctx, ) List all logs

Required Parameters

This endpoint does not need any parameter.

Return type

ArrayOfLogsResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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

ListTagsByLogId

ArrayOfTagsResponse ListTagsByLogId(ctx, logId) Lists all tags associated with a log

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
logId int64 The id of the log to retrieve

Return type

ArrayOfTagsResponse

Authorization

ApiKeyAuth

HTTP request headers

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

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