CampusAPI Forum Services API documentation version 0.1.5
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", "poster", 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%3AexamplePostType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePostType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePostType%40campusapi.org

• fromDate: (string)

  Get all posts from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all posts up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• posterId: (string)

  Id string to match poster.

  Example:

  resource.Resource%3A7836%40base.url

• forumId: (string)

  The id string to match a forum

  Example:

  forum.Forum%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular post type to create

  Example:

  type.Type%3AexamplePostType%40dxtera.org

• recordType: (array of )

  specify support for one or more post record types

  Example:

  [
    "type.Type%3AexamplePostRecordType%40campusapi.org",
    "..."
  ]

• forumId: (string)

  specify in which forum to create this post

  Example:

  forum.Forum%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Post",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this post, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this post.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post. 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 post. 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
    },
    "timestamp": {
      "description": "The time of this post.",
      "type": "string",
      "format": "date-time"
    },
    "posterId": {
      "description": "The poster of this post.",
      "type": "string",
      "format": "osid-id"
    },
    "subjectLine": {
      "description": "The subject line of this post.",
      "type": "string"
    },
    "text": {
      "description": "The text of the post.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Post",
  "description": "The description of this Post",
  "timestamp": "2021-07-21T23:15:30.000Z",
  "posterId": "resource.Resource:4468@base.url",
  "subjectLine": "This is the SubjectLine",
  "text": "This is the Text"
}

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", "poster", 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": "PostQuery",
  "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"
          }
        }
      }
    },
    "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 Posts with any timestamp, false to match ProgramOfferings with no timestamp",
      "type": "boolean"

    },
    "matchPosterIds": {
      "description": "List of Resource Ids for this query to match poster.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "posterId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "posterQueries": {
      "description": "resource.ResourceQueries to match the Poster. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyPoster": {
      "description": "Match poster with any value. true to match Posts with any poster, false to match Posts with no poster",
      "type": "boolean"
    },
    "matchSubjectLine": {
      "description": "List of SubjectLine strings to match. Boolean OR performed among multiple subjectLines.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "subjectLines": {
            "description": "subjectLines 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"
          }
        }
      }
    },
    "matchAnySubjectLine": {
      "description": "Match subjectLines with any value. true to match Posts with any subject line, false to match ProgramOfferings with no subject line",
      "type": "boolean"

    },
    "matchText": {
      "description": "List of Text strings to match. Boolean OR performed among multiple texts.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "texts": {
            "description": "texts 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"
          }
        }
      }
    },
    "matchAnyText": {
      "description": "Match texts with any value. true to match Posts with any text, false to match ProgramOfferings with no text",
      "type": "boolean"

    },
    "matchForumIds": {
      "description": "List of Forum Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "forumId": {
            "description": "Forum id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "forumQueries": {
      "description": "ForumQueries to match Forum. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• genusType: (string)

  specify a particular post type to create

  Example:

  type.Type%3AexamplePostType%40dxtera.org

• recordType: (array of )

  specify support for one or more post record types

  Example:

  [
    "type.Type%3AexamplePostRecordType%40campusapi.org",
    "..."
  ]

• forumId: (string)

  specify in which forum to create this post

  Example:

  forum.Forum%3A8374%40base.url

URI Parameters

• postId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• postId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Post",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this post, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this post, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this post for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this post.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this post. 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 post. 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
    },
    "timestamp": {
      "description": "The time of this post.",
      "type": "string",
      "format": "date-time"
    },
    "posterId": {
      "description": "The poster of this post.",
      "type": "string",
      "format": "osid-id"
    },
    "subjectLine": {
      "description": "The subject line of this post.",
      "type": "string"
    },
    "text": {
      "description": "The text of the post.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Post",
  "description": "The description of this Post",
  "timestamp": "2021-07-21T23:15:30.000Z",
  "posterId": "resource.Resource:4468@base.url",
  "subjectLine": "This is the SubjectLine",
  "text": "This is the Text"
}

URI Parameters

• postId: required(string)

URI Parameters

• postId: 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", "poster", "post", "reply", 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%3AexampleReplyType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleReplyType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleReplyType%40campusapi.org

• postId: (string)

  the id string to match a post.

  Example:

  forum.Post%3A100%40base.url

• replyId: (string)

  the id string to match a reply.

  Example:

  forum.Post%3A125%40base.url

• fromDate: (string)

  Get all replys from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all replys up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• posterId: (string)

  Id string to match poster.

  Example:

  resource.Resource%3A6392%40base.url

• forumId: (string)

  The id string to match a forum

  Example:

  forum.Forum%3A8374%40base.url

Query Parameters

• postId: required(string)

  the post of this reply.

  Example:

  forum.Post%3A100%40base.url

• replyId: required(string)

  the reply of this reply.

  Example:

  forum.Post%3A125%40base.url

• genusType: (string)

  specify a particular reply type to create

  Example:

  type.Type%3AexampleReplyType%40dxtera.org

• recordType: (array of )

  specify support for one or more reply record types

  Example:

  [
    "type.Type%3AexampleReplyRecordType%40campusapi.org",
    "..."
  ]

• forumId: (string)

  specify in which forum to create this reply

  Example:

  forum.Forum%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Reply",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this reply, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this reply, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this reply for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this reply.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this reply. 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 reply. 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
    },
    "sequestered": {
      "description": "Whether this reply is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "postId": {
      "description": "The post associated with this reply.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "replyId": {
      "description": "The reply associated with this reply.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "timestamp": {
      "description": "The time of this entry.",
      "type": "string",
      "format": "date-time"
    },
    "posterId": {
      "description": "The posting of this entry.",
      "type": "string",
      "format": "osid-id"
    },
    "subjectLine": {
      "description": "The subject line of this entry.",
      "type": "string"
    },
    "text": {
      "description": "The text of the entry.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Reply",
  "description": "The description of this Reply",
  "sequestered": false,
  "timestamp": "2021-07-21T23:15:30.000Z",
  "posterId": "resource.Resource:1128@base.url",
  "subjectLine": "This is the SubjectLine",
  "text": "This is the Text"
}

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", "poster", "post", "reply", 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": "ReplyQuery",
  "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"
          }
        }
      }
    },
    "matchSequestered": {
      "description": "Match containables that are sequestered.  true to match any sequestered containables, false to match non-sequestered containables",
      "type": "boolean"
    },
    "matchPostIds": {
      "description": "List of post Ids for this query to match reply that have a related post.",
      "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"
          }
        }
      }
    },
    "postQueries": {
      "description": "PostQueries to match the post. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchReplyIds": {
      "description": "List of reply Ids for this query to match reply that have a related reply.",
      "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"
          }
        }
      }
    },
    "replyQueries": {
      "description": "ReplyQueries to match the reply. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "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 Replys with any timestamp, false to match ProgramOfferings with no timestamp",
      "type": "boolean"

    },
    "matchPosterIds": {
      "description": "List of Resource Ids for this query to match poster.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "posterId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "posterQueries": {
      "description": "resource.ResourceQueries to match the Poster. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyPoster": {
      "description": "Match poster with any value. true to match Replys with any poster, false to match Replys with no poster",
      "type": "boolean"
    },
    "matchSubjectLine": {
      "description": "List of SubjectLine strings to match. Boolean OR performed among multiple subjectLines.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "subjectLines": {
            "description": "subjectLines 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"
          }
        }
      }
    },
    "matchAnySubjectLine": {
      "description": "Match subjectLines with any value. true to match Replys with any subject line, false to match ProgramOfferings with no subject line",
      "type": "boolean"

    },
    "matchText": {
      "description": "List of Text strings to match. Boolean OR performed among multiple texts.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "texts": {
            "description": "texts 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"
          }
        }
      }
    },
    "matchAnyText": {
      "description": "Match texts with any value. true to match Replys with any text, false to match ProgramOfferings with no text",
      "type": "boolean"

    },
    "matchForumIds": {
      "description": "List of Forum Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "forumId": {
            "description": "Forum id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "forumQueries": {
      "description": "ForumQueries to match Forum. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• postId: required(string)

  the post of this metadatum.

  Example:

  forum.Post%3A100%40base.url

• replyId: required(string)

  the reply of this metadatum.

  Example:

  forum.Post%3A125%40base.url

• genusType: (string)

  specify a particular reply type to create

  Example:

  type.Type%3AexampleReplyType%40dxtera.org

• recordType: (array of )

  specify support for one or more reply record types

  Example:

  [
    "type.Type%3AexampleReplyRecordType%40campusapi.org",
    "..."
  ]

• forumId: (string)

  specify in which forum to create this reply

  Example:

  forum.Forum%3A8374%40base.url

URI Parameters

• replyId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• replyId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Reply",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this reply, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this reply, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this reply for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this reply.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this reply. 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 reply. 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
    },
    "sequestered": {
      "description": "Whether this reply is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "postId": {
      "description": "The post associated with this reply.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "replyId": {
      "description": "The reply associated with this reply.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "timestamp": {
      "description": "The time of this entry.",
      "type": "string",
      "format": "date-time"
    },
    "posterId": {
      "description": "The posting of this entry.",
      "type": "string",
      "format": "osid-id"
    },
    "subjectLine": {
      "description": "The subject line of this entry.",
      "type": "string"
    },
    "text": {
      "description": "The text of the entry.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Reply",
  "description": "The description of this Reply",
  "sequestered": false,
  "timestamp": "2021-07-21T23:15:30.000Z",
  "posterId": "resource.Resource:1128@base.url",
  "subjectLine": "This is the SubjectLine",
  "text": "This is the Text"
}

URI Parameters

• replyId: required(string)

URI Parameters

• replyId: 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

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleForumType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleForumType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleForumType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• postId: (string)

  Get forums mapped to this post.

  Example:

  forum.Post%3A100%40demo.dxtera.org

• replyId: (string)

  Get forums mapped to this reply.

  Example:

  forum.Reply%3A125%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular forum type to create

  Example:

  type.Type%3AexampleForumType%40dxtera.org

• recordType: (array of )

  specify support for one or more forum record types

  Example:

  [
    "type.Type%3AexampleForumRecordType%40campusapi.org",
    "..."
  ]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Forum",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this forum, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this forum, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this forum for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this forum.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this forum. 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 forum. 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 forum.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this forum. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this forum.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Forum",
  "description": "The description of this Forum",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Forum@base.url",
  "license": "The license that applies to this Forum"
}

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": "ForumQuery",
  "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 Forum with any provider, false to match Forum 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 Forum with any branding, false to match Forum 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"
          }
        }
      }
    },
    "matchForumIds": {
      "description": "List of Forum Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "forumId": {
            "description": "Forum id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "forumQueries": {
      "description": "ForumQueries to match Forum. 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:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Forum",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this forum, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this forum, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this forum for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Forum.Forum:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this forum",
      "linked": false
    },
    "description": {
      "description": "The description of this forum.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Forum.Forum:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this forum",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this forum. 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 forum. 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 forum.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Forum.Forum:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this forum",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this forum. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Forum.Forum:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this forum",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this forum.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Forum.Forum:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this forum",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "forum.Forum:1281@base.url",
    "uri": "http://base.url/open/campusapi/forum/forum/forum.Forum%3A1281%40base.url",
    "displayName": "Display Name of this Forum",
    "description": "The description of this Forum",
    "genusTypeId": "type.Type:defaultForumType@base.url",
    "recordTypeIds": [ "type.Type:exampleForumRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Forum@base.url",
    "license": "The license that applies to this Forum"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• forumId: required(string)

URI Parameters

• forumId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Forum",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this forum, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this forum, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this forum for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this forum.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this forum. 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 forum. 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 forum.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this forum. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this forum.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Forum",
  "description": "The description of this Forum",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Forum@base.url",
  "license": "The license that applies to this Forum"
}

URI Parameters

• forumId: required(string)

URI Parameters

• forumId: required(string)

URI Parameters

• forumId: required(string)

URI Parameters

• forumId: required(string)
• childId: required(string)

URI Parameters

• forumId: required(string)
• childId: required(string)

URI Parameters

• forumId: required(string)

URI Parameters

• forumId: 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", "poster", 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%3AexamplePostType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePostType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePostType%40campusapi.org

URI Parameters

• forumId: required(string)
• postId: required(string)

URI Parameters

• forumId: required(string)
• postId: required(string)

URI Parameters

• forumId: 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", "poster", "post", "reply", 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%3AexampleReplyType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleReplyType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleReplyType%40campusapi.org

URI Parameters

• forumId: required(string)
• replyId: required(string)

URI Parameters

• forumId: required(string)
• replyId: required(string)