CampusAPI Logging Services API documentation version 0.1.0
Based on OSID version 3.0.0

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

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• 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%40base.url

• 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

Query Parameters

• 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",
  "required": ["agentId"],
  "properties": {
    "id": {
      "description": "The unique id of this log entry. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this log entry. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "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",
  "agentId": "authentication.Agent:388@base.url",
  "priority": "type.Type:1871@base.url",
  "timestamp": "2021-07-21T23:15:30.000Z"
}

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"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "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": "agent-query"
      }
    },
    "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": "agent-query"
      }
    },
    "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": "log-query"
      }
    }
  }
}

Example:

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

Query Parameters

• 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": "LogEntryBatch",
    "type": "array",
    "Items": {
        "type": "log-entry"
    }
}

Example:

[
  {
    "displayName": "Display Name of this LogEntry",
    "description": "The description of this LogEntry",
    "priority": "type.Type:4472@base.url",
    "timestamp": "2021-07-21T23:15:30.000Z"
  },
  {
    "...": "..."
  }
]

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

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

URI Parameters

• logEntryId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LogEntryItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this log entry. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this log entry. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "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:3081@base.url",
  "timestamp": "2021-07-21T23:15:30.000Z"
}

URI Parameters

• logEntryId: required(string)

URI Parameters

• logEntryId: 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", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• 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

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. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this log. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "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"
}

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", "provider", "branding", 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"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "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": "providerQueries to match the provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "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.AssetQueries to match the branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "asset-query"
      }
    },
    "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": "log-query"
      }
    }
  }
}

Example:

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

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

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", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• logId: required(string)

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", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

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", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• childId: required(string)

URI Parameters

• childId: required(string)

URI Parameters

• logId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• logId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LogItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this log. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this log. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "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"
}

URI Parameters

• logId: required(string)

URI Parameters

• logId: required(string)

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

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• 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

URI Parameters

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

URI Parameters

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

URI Parameters

• logId: required(string)

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"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "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": "agent-query"
      }
    },
    "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": "agent-query"
      }
    },
    "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": "log-query"
      }
    }
  }
}

Example:

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

URI Parameters

• logId: required(string)