CampusAPI Logging Services API documentation version 0.1.2
Based on OSID version 3.0.0
https://base.url/logging
Overview
The Logging service package provides a means to read and wite to logs.
This package includes the following entities:
LogEntries
A Log represents a collection of log entries. Each log entry is composed of a priority Type, timestamp, Agent, the agent's associated Resource, and any extensions based on Type.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this log entry, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this log entry, provided by system. | string(uri) |
| displayName | The name of this log entry for display. | string |
| description | The description of this log entry. | string |
| genusTypeId (read‑only) | Id of the immutable type of this log entry. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this log entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| agentId (read‑only) | The agent associated with this log entry. References an authentication.Agent object. | string(osid‑id) |
| priority | The priority level of this entry. | string(osid‑type) |
| timestamp | The time this entry was logged. | string(date‑time) |
| agentId | The Agent who created this entry. References an authentication.Agent object | string(osid‑id) |
Logs
A Log represents a collection of entries. Logs can be organized into hierarchies for federation. A log that is a parent of another log makes visible the log entries of its children.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this log, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this log, provided by system. | string(uri) |
| displayName | The name of this log for display. | string |
| description | The description of this log. | string |
| genusTypeId (read‑only) | Id of the immutable type of this log. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this log. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this log. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this log. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this log. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/log-entries
Collection of log-entries in a system, federation of systems, or in a default log.
get
Get all log-entries in the system or default log.
post
Create a new log-entry in the default log.
get /log-entries
Get all log-entries in the system or default log.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleLogEntryType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleLogEntryType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleLogEntryType%40campusapi.org - agentId: (string)
the id string to match a agent.
Example:
authentication.Agent%3A560%40base.url - resourceId: (string)
Id string to match resource.
Example:
resource.Resource%3A7836%40demo.dxtera.org - fromDate: (string)
Get all log-entries from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all log-entries up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - logId: (string)
The id string to match a log
Example:
logging.Log%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "logging.LogEntry:3936@base.url",
"uri": "http://base.url/open/campusapi/logging/log_entry/logging.LogEntry%3A3936%40base.url",
"displayName": "Display Name of this LogEntry",
"description": "The description of this LogEntry",
"genusTypeId": "type.Type:defaultLogEntryType@base.url",
"recordTypeIds": [ "type.Type:exampleLogEntryRecordType@campusapi.org", "..."],
"agentId": "authentication.Agent:5023@base.url",
"priority": "type.Type:1704@base.url",
"timestamp": "2021-07-21T23:15:30.000Z"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /log-entries
Create a new log-entry in the default log.
Query Parameters
- agentId: required(string)
the agent of this log-entry.
Example:
authentication.Agent%3A560%40base.url - genusType: (string)
specify a particular logEntry type to create
Example:
type.Type%3AexampleLogEntryType%40dxtera.org - recordType: (array of )
specify support for one or more logEntry record types
Example:
[ "type.Type%3AexampleLogEntryRecordType%40campusapi.org", "..." ] - logId: (string)
specify in which log to create this logEntry
Example:
logging.Log%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "LogEntry",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this log entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log entry for display.",
"type": "string"
},
"description": {
"description": "The description of this log entry.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this log entry. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"agentId": {
"description": "The agent associated with this log entry.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"priority": {
"description": "The priority level of this entry.",
"type": "string",
"format": "osid-type"
},
"timestamp": {
"description": "The time this entry was logged.",
"type": "string",
"format": "date-time"
},
"agentId": {
"description": "The Agent who created this entry.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this LogEntry",
"description": "The description of this LogEntry",
"priority": "type.Type:2322@base.url",
"timestamp": "2021-07-21T23:15:30.000Z"
}
Entity representing a logEntry form metadata.
get
Get form metadata for creating a new logEntry.
get /log-entries/metadata
Get form metadata for creating a new logEntry.
Query Parameters
- agentId: required(string)
the agent of this metadatum.
Example:
authentication.Agent%3A560%40base.url - genusType: (string)
specify a particular logEntry type to create
Example:
type.Type%3AexampleLogEntryType%40dxtera.org - recordType: (array of )
specify support for one or more logEntry record types
Example:
[ "type.Type%3AexampleLogEntryRecordType%40campusapi.org", "..." ] - logId: (string)
specify in which log to create this logEntry
Example:
logging.Log%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "LogEntry",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this log entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log entry for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "LogEntry.LogEntry:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this log entry",
"linked": false
},
"description": {
"description": "The description of this log entry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "LogEntry.LogEntry:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this log entry",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this log entry. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"priority": {
"description": "The priority level of this entry.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "logging.LogEntry:priority@dxtera.org",
"existingValue": null,
"elementLabel": "Priority",
"instructions": "Enter the Type id of the priority for this log entry.",
"linked": false
},
"timestamp": {
"description": "The time this entry was logged.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "logging.LogEntry:timestamp@dxtera.org",
"existingValue": "",
"elementLabel": "Timestamp",
"instructions": "Enter the timestamp of this log entry.",
"linked": false
},
"agentId": {
"description": "The Agent who created this entry.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "logging.LogEntry:agent@dxtera.org",
"existingValue": null,
"elementLabel": "Agent",
"instructions": "Enter the Id of the agent for this log entry.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a log-entry
get
Get a log-entry given its id.
put
Update a given log-entry.
delete
Delete a given log-entry.
get /log-entries/{logEntryId}
Get a log-entry given its id.
URI Parameters
- logEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "logging.LogEntry:3936@base.url",
"uri": "http://base.url/open/campusapi/logging/log_entry/logging.LogEntry%3A3936%40base.url",
"displayName": "Display Name of this LogEntry",
"description": "The description of this LogEntry",
"genusTypeId": "type.Type:defaultLogEntryType@base.url",
"recordTypeIds": [ "type.Type:exampleLogEntryRecordType@campusapi.org", "..."],
"agentId": "authentication.Agent:5023@base.url",
"priority": "type.Type:1704@base.url",
"timestamp": "2021-07-21T23:15:30.000Z"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "log-entry not found" }
put /log-entries/{logEntryId}
Update a given log-entry.
URI Parameters
- logEntryId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "LogEntry",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this log entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log entry for display.",
"type": "string"
},
"description": {
"description": "The description of this log entry.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this log entry. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"agentId": {
"description": "The agent associated with this log entry.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"priority": {
"description": "The priority level of this entry.",
"type": "string",
"format": "osid-type"
},
"timestamp": {
"description": "The time this entry was logged.",
"type": "string",
"format": "date-time"
},
"agentId": {
"description": "The Agent who created this entry.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this LogEntry",
"description": "The description of this LogEntry",
"priority": "type.Type:2322@base.url",
"timestamp": "2021-07-21T23:15:30.000Z"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The log-entry has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "log-entry not found" }
delete /log-entries/{logEntryId}
Delete a given log-entry.
URI Parameters
- logEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The log-entry has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "log-entry not found" }
Entity representing a logEntry form metadata for update
get
Get form metadata for updating an existing logEntry.
get /log-entries/{logEntryId}/metadata
Get form metadata for updating an existing logEntry.
URI Parameters
- logEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "LogEntry",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this log entry, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log entry, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log entry for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "LogEntry.LogEntry:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this log entry",
"linked": false
},
"description": {
"description": "The description of this log entry.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "LogEntry.LogEntry:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this log entry",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this log entry. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log entry. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"priority": {
"description": "The priority level of this entry.",
"type": "string",
"type": "string",
"format": "osid-type",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "logging.LogEntry:priority@dxtera.org",
"existingValue": null,
"elementLabel": "Priority",
"instructions": "Enter the Type id of the priority for this log entry.",
"linked": false
},
"timestamp": {
"description": "The time this entry was logged.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "logging.LogEntry:timestamp@dxtera.org",
"existingValue": "",
"elementLabel": "Timestamp",
"instructions": "Enter the timestamp of this log entry.",
"linked": false
},
"agentId": {
"description": "The Agent who created this entry.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "logging.LogEntry:agent@dxtera.org",
"existingValue": null,
"elementLabel": "Agent",
"instructions": "Enter the Id of the agent for this log entry.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "logEntry not found" }
/logs
Collection of logs in a system or federation of systems.
get
Get all logs.
post
Create a new log.
get /logs
Get all logs.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleLogType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleLogType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleLogType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - logEntryId: (string)
Get logs mapped to this log-entry.
Example:
logging.LogEntry%3A189%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "logging.Log:2693@base.url",
"uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2693%40base.url",
"displayName": "Display Name of this Log",
"description": "The description of this Log",
"genusTypeId": "type.Type:defaultLogType@base.url",
"recordTypeIds": [ "type.Type:exampleLogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Log@base.url",
"license": "The license that applies to this Log"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /logs
Create a new log.
Query Parameters
- genusType: (string)
specify a particular log type to create
Example:
type.Type%3AexampleLogType%40dxtera.org - recordType: (array of )
specify support for one or more log record types
Example:
[ "type.Type%3AexampleLogRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Log",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this log, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log for display.",
"type": "string"
},
"description": {
"description": "The description of this log.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this log. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this log.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this log. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this log.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Log",
"description": "The description of this Log",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Log@base.url",
"license": "The license that applies to this Log"
}
Entity representing a log form metadata.
get
Get form metadata for creating a new log.
get /logs/metadata
Get form metadata for creating a new log.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Log",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this log, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this log",
"linked": false
},
"description": {
"description": "The description of this log.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this log",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this log. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this log.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this log",
"linked": false
},
"brandingIds": {
"description": "The branding of this log. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Log.Log:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this log",
"linked": false
},
"license": {
"description": "The licensing that applies to this log.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this log",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root logs in the log hierarchy. A node with no parents is an orphan. While all log Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
get
Get all root root-log
get /logs/root-log
Get all root root-log
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "logging.Log:2693@base.url",
"uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2693%40base.url",
"displayName": "Display Name of this Log",
"description": "The description of this Log",
"genusTypeId": "type.Type:defaultLogType@base.url",
"recordTypeIds": [ "type.Type:exampleLogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Log@base.url",
"license": "The license that applies to this Log"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a log
get
Get a log given its id.
put
Update a given log.
delete
Delete a given log.
get /logs/{logId}
Get a log given its id.
URI Parameters
- logId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "logging.Log:2693@base.url",
"uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2693%40base.url",
"displayName": "Display Name of this Log",
"description": "The description of this Log",
"genusTypeId": "type.Type:defaultLogType@base.url",
"recordTypeIds": [ "type.Type:exampleLogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Log@base.url",
"license": "The license that applies to this Log"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "log not found" }
put /logs/{logId}
Update a given log.
URI Parameters
- logId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Log",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this log, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log for display.",
"type": "string"
},
"description": {
"description": "The description of this log.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this log. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this log.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this log. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this log.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Log",
"description": "The description of this Log",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Log@base.url",
"license": "The license that applies to this Log"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The log has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "log not found" }
delete /logs/{logId}
Delete a given log.
URI Parameters
- logId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The log has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "log not found" }
Entity representing a log form metadata for update
get
Get form metadata for updating an existing log.
get /logs/{logId}/metadata
Get form metadata for updating an existing log.
URI Parameters
- logId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Log",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this log, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this log, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this log for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this log",
"linked": false
},
"description": {
"description": "The description of this log.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this log",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this log. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this log. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this log.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this log",
"linked": false
},
"brandingIds": {
"description": "The branding of this log. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Log.Log:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this log",
"linked": false
},
"license": {
"description": "The licensing that applies to this log.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Log.Log:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this log",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "log not found" }
get
Get child logs for the given log in the hierarchy.
get /logs/{logId}/children
Get child logs for the given log in the hierarchy.
URI Parameters
- logId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "logging.Log:2693@base.url",
"uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2693%40base.url",
"displayName": "Display Name of this Log",
"description": "The description of this Log",
"genusTypeId": "type.Type:defaultLogType@base.url",
"recordTypeIds": [ "type.Type:exampleLogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Log@base.url",
"license": "The license that applies to this Log"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add log as child of the given log in the hierarchy.
delete
Remove the given log as a child of the given log in the hierarchy.
put /logs/{logId}/children/{childId}
Add log as child of the given log in the hierarchy.
URI Parameters
- logId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child log has been added to the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "log not found" }
delete /logs/{logId}/children/{childId}
Remove the given log as a child of the given log in the hierarchy.
URI Parameters
- logId: required(string)
- childId: required(string)
get
Get parent logs for the given log in the hierarchy.
get /logs/{logId}/parents
Get parent logs for the given log in the hierarchy.
URI Parameters
- logId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "logging.Log:2693@base.url",
"uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2693%40base.url",
"displayName": "Display Name of this Log",
"description": "The description of this Log",
"genusTypeId": "type.Type:defaultLogType@base.url",
"recordTypeIds": [ "type.Type:exampleLogRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Log@base.url",
"license": "The license that applies to this Log"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get all log-entries in this log
get /logs/{logId}/log-entries
Get all log-entries in this log
URI Parameters
- logId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "logging.LogEntry:3936@base.url",
"uri": "http://base.url/open/campusapi/logging/log_entry/logging.LogEntry%3A3936%40base.url",
"displayName": "Display Name of this LogEntry",
"description": "The description of this LogEntry",
"genusTypeId": "type.Type:defaultLogEntryType@base.url",
"recordTypeIds": [ "type.Type:exampleLogEntryRecordType@campusapi.org", "..."],
"agentId": "authentication.Agent:5023@base.url",
"priority": "type.Type:1704@base.url",
"timestamp": "2021-07-21T23:15:30.000Z"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given log-entry to this log
delete
Remove the given log-entry from the log.
put /logs/{logId}/log-entries/{logEntryId}
Add the given log-entry to this log
URI Parameters
- logId: required(string)
- logEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "log-entry has been added to log" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "log-entry not found" }
delete /logs/{logId}/log-entries/{logEntryId}
Remove the given log-entry from the log.
URI Parameters
- logId: required(string)
- logEntryId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "log-entry has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "log-entry not found" }