CampusAPI Logging Services API documentation version 0.1.5
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.

FieldDescriptionType
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)
displayNameThe name of this log entry for display.string
descriptionThe 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)
priorityThe priority level of this entry.string(osid‑type)
timestampThe time this entry was logged.string(date‑time)
agentIdThe Agent who created this entry. References an authentication.Agent objectstring(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.

FieldDescriptionType
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)
displayNameThe name of this log for display.string
descriptionThe 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)[]
providerIdThe provider of this log. References a resource.Resource object.string(osid‑id)
brandingIdsThe branding of this log. References repository.Asset objects.string(osid‑id)[]
licenseThe licensing that applies to this log.string

License

CampusAPI REST Documentation Copyright 2023 DXtera Institute. Based on the Open Service Interface Definitions: http://osid.org

/log-entries

Collection of LogEntries in a system, federation of systems, or in a default Log.

get post

get

Get all LogEntries in the system or default Log.

post

Create a new LogEntry in the default Log.

Create a new LogEntry 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:5055@base.url",
  "timestamp": "2021-07-21T23:15:30.000Z"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The LogEntry has been created",
  "log-entryId": "logging.LogEntry:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

post

Query the collection of LogEntries in a system, federation of systems, or in a default log by posting a Query object.

post

Submit a query using a LogEntryQuery object.

Submit a query using a LogEntryQuery object.

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
  • expand: (string)

    Expand object or type for named attribute: "genusType", "recordType", "priority", "agent", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

    Example:

    all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LogEntryQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAgentIds": {
      "description": "List of agent Ids for this query to match log entry that have a related agent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "agentQueries": {
      "description": "AgentQueries to match the agent. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchPriority": {
      "description": "List of Type Ids for this query to match priority.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "priorityType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchTimestamp": {
      "description": "Matches timestamps between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTimestamp": {
      "description": "Match timestamps with any value. true to match LogEntries with any timestamp, false to match ProgramOfferings with no timestamp",
      "type": "boolean"

    },
    "matchAgentIds": {
      "description": "List of Agent Ids for this query to match agent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "agentId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "agentQueries": {
      "description": "authentication.AgentQueries to match the Agent. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyAgent": {
      "description": "Match agent with any value. true to match LogEntries with any agent, false to match LogEntries with no agent",
      "type": "boolean"
    },
    "matchLogIds": {
      "description": "List of Log Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "logId": {
            "description": "Log id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "logQueries": {
      "description": "LogQueries to match Log. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "logging.LogEntry:8536@base.url",
    "uri": "http://base.url/open/campusapi/logging/log_entry/logging.LogEntry%3A8536%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:6071@base.url",
    "priority": "type.Type:6444@base.url",
    "timestamp": "2021-07-21T23:15:30.000Z"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

Entity representing a LogEntry form metadata.

get

Get form metadata for creating a new LogEntry.

get put delete

Entity representing a LogEntry

get

Get a particular LogEntry given its id.

put

Update a particular LogEntry given its id.

delete

Delete a particular LogEntry given its id.

Get a particular LogEntry given its id.

URI Parameters

  • logEntryId: required(string)

Query Parameters

  • expand: (string)

    Expand object or type for named attribute: "genusType", "recordType", "priority", "agent", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

    Example:

    all

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "logging.LogEntry:8536@base.url",
  "uri": "http://base.url/open/campusapi/logging/log_entry/logging.LogEntry%3A8536%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:6071@base.url",
  "priority": "type.Type:6444@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": "LogEntry not found" }

Update a particular LogEntry given its id.

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:5055@base.url",
  "timestamp": "2021-07-21T23:15:30.000Z"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The LogEntry 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": "LogEntry not found" }

Delete a particular LogEntry given its id.

URI Parameters

  • logEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The LogEntry 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": "LogEntry not found" }

get

Entity representing a LogEntry form metadata for update

get

Get form metadata for updating an existing LogEntry.

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 post

get

Get all Logs.

post

Create a new Log.

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"
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "The Log has been created",
  "logId": "logging.Log:9876@demo.dxtera.org"}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

post

Query the collection of Logs in a system, federation of systems, or in a default log by posting a Query object.

post

Submit a query using a LogQuery object.

Submit a query using a LogQuery object.

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
  • expand: (string)

    Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

    Example:

    all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LogQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Log with any provider, false to match Log with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Log with any branding, false to match Log with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchLogIds": {
      "description": "List of Log Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "logId": {
            "description": "Log id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "logQueries": {
      "description": "LogQueries to match Log. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "logging.Log:2763@base.url",
    "uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2763%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

Entity representing a Log form metadata.

get

Get form metadata for creating a new Log.

get

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 put delete

Entity representing a Log

get

Get a particular Log given its id.

put

Update a particular Log given its id.

delete

Delete a particular Log given its id.

Get a particular Log given its id.

URI Parameters

  • logId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": "logging.Log:2763@base.url",
  "uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2763%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" }

Update a particular Log given its id.

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 a particular Log given its id.

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" }

get

Entity representing a Log form metadata for update

get

Get form metadata for updating an existing Log.

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

Get child Logs for the given Log in the hierarchy.

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:2763@base.url",
    "uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2763%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 delete

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.

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" }

Remove the given Log as a 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 removed from the hierarchy" }

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

get

get

Get parent Logs for the given Log in the hierarchy.

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:2763@base.url",
    "uri": "http://base.url/open/campusapi/logging/log/logging.Log%3A2763%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

Get all LogEntries in this Log

Get all LogEntries in this Log

URI Parameters

  • logId: required(string)

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
  • expand: (string)

    Expand object or type for named attribute: "genusType", "recordType", "priority", "agent", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

    Example:

    all
  • 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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "logging.LogEntry:8536@base.url",
    "uri": "http://base.url/open/campusapi/logging/log_entry/logging.LogEntry%3A8536%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:6071@base.url",
    "priority": "type.Type:6444@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 delete

put

Add the given LogEntry to this Log

delete

Remove the given LogEntry from the Log.

Add the given LogEntry to this Log

URI Parameters

  • logId: required(string)
  • logEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "LogEntry 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": "LogEntry not found" }

Remove the given LogEntry from the Log.

URI Parameters

  • logId: required(string)
  • logEntryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{ "message": "LogEntry 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": "LogEntry not found" }