Files API

API change history

List of APIs related to folders which contain files

Search folders and file

Search folders and files within a top resource ID (folder or module). The files and folders are searched by the folder names, file names, url, url description or creator name.

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. Folder ID/module ID

  • (optional)
    string

    Searched text. Minimum 3 characters.

  • (optional)
    string

    Accepted populate entities: comment

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Searched files information and folders informations

Representations

{
  "description": "searched folders, files and urls",
  "type": "object",
  "properties": {
    "folders": {
      "description": "searched folders",
      "type": "array",
      "items": {
        "description": "returned folder information",
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "identifier",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "description": "The date this record is created",
            "type": "string"
          },
          "creatorID": {
            "format": "uuid",
            "description": "the ID of the user who created this record",
            "type": "string"
          },
          "creatorName": {
            "description": "The name of the user who created the record",
            "type": "string"
          },
          "creatorUserID": {
            "description": "The user ID of the user who created the record",
            "type": "string"
          },
          "creatorEmail": {
            "description": "The email address of the user who created the record",
            "type": "string"
          },
          "lastUpdatedDate": {
            "format": "date-time",
            "description": "the date this record is edited last time",
            "type": "string"
          },
          "lastUpdatedBy": {
            "format": "uuid",
            "description": "the ID of the user who edited this record last time",
            "type": "string"
          },
          "lastUpdatedByName": {
            "description": "The name of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByUserID": {
            "description": "The user ID of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByEmail": {
            "description": "The email address of the user who last updated the record",
            "type": "string"
          },
          "name": {
            "description": "the name/title of the resource",
            "type": "string"
          },
          "startDate": {
            "format": "date-time",
            "description": "the date which this resource is open to students.",
            "type": "string"
          },
          "endDate": {
            "format": "date-time",
            "description": "the date which this resource is closed from students.",
            "type": "string"
          },
          "publish": {
            "description": "the publish flag which determin whether the resource is published to students.",
            "type": "boolean"
          },
          "parentID": {
            "format": "uuid",
            "description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "rootID": {
            "format": "uuid",
            "description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "feedbackReleaseDate": {
            "format": "date-time",
            "description": "the feedback release date used for turnitin folder.",
            "type": "string"
          },
          "isActive": {
            "description": "Indicate whether the folder is open or close",
            "type": "boolean",
            "readOnly": true
          },
          "parentFolderPath": {
            "description": "path of parent folder when populated",
            "type": "string"
          },
          "sortFilesBy": {
            "description": "the default sort columns when displaying files inside this folder, value can be : Date,Name,Owner,Size,Order",
            "type": "string"
          },
          "allowUpload": {
            "description": "flag to indicate whether students are allowed to submit documents to this folder",
            "type": "boolean"
          },
          "uploadDisplayOption": {
            "description": "The identity of the file uploader to be displayed, value can be : Matrix,Name,None",
            "type": "string"
          },
          "viewAll": {
            "description": "flag to indicate whether students can view documents uploaded by others",
            "type": "boolean"
          },
          "folderScore": {
            "format": "double",
            "description": "The full score assigned for this student submission folder, 0 means no marking on this assignment",
            "type": "number"
          },
          "allowComments": {
            "description": "allow student to comment",
            "type": "boolean"
          },
          "allowAnnotate": {
            "description": "allow student to view annotations, create annotations, reply annotations.",
            "type": "boolean"
          },
          "submissionDeadline": {
            "format": "date-time",
            "description": "The deadline which student are allowed to submit their document.StartDate --> SubmissionDeadline --> EndDate",
            "type": "string"
          },
          "allowLateSubmission": {
            "description": "allow student to submit their assignment after the deadline. Those submission will become late submission, used together with SubmissionDeadline",
            "type": "boolean"
          },
          "isTurnitinFolder": {
            "description": "true measn this folder is a turnitin submission folder",
            "type": "boolean"
          },
          "allowedFileType": {
            "description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "allowedSubmissionFileTypes": {
            "description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
            "type": "array",
            "items": {
              "description": "Name of the restrited file type",
              "required": [
                "fileTypeName"
              ],
              "type": "object",
              "properties": {
                "fileTypeName": {
                  "description": "Name of the file type",
                  "type": "string"
                },
                "extensions": {
                  "description": "file type extensions",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "files": {
      "description": "searched files",
      "type": "array",
      "items": {
        "description": "searched folders, files and urls",
        "required": [
          "description",
          "fileFormat",
          "fileName",
          "fileSize",
          "url"
        ],
        "type": "object",
        "properties": {
          "comment": {
            "description": "comments made on this file/weblink",
            "type": "array",
            "items": {
              "description": "the comment and scoring model",
              "type": "object",
              "properties": {
                "fileRemarksAttachment": {
                  "description": "the name of the file which attached to this comment",
                  "type": "string"
                },
                "id": {
                  "format": "uuid",
                  "description": "ID of the Mark/Comment",
                  "type": "string"
                },
                "targetID": {
                  "format": "uuid",
                  "description": "Target ID which this comment/mark for",
                  "type": "string"
                },
                "resourceID": {
                  "format": "uuid",
                  "description": "the folder ID  or tool ID which contains this comment/mark",
                  "type": "string"
                },
                "publish": {
                  "description": "the publish flag which determine whether the record is published to students.",
                  "type": "boolean"
                },
                "mark": {
                  "format": "float",
                  "description": "Marks entered for the student",
                  "type": "number"
                },
                "moderation": {
                  "format": "float",
                  "description": "Moderation entered for the student",
                  "type": "number"
                },
                "finalMark": {
                  "format": "float",
                  "description": "Final Mark for the student (computed column)",
                  "type": "number",
                  "readOnly": true
                },
                "remark": {
                  "description": "Remarks entered for the student",
                  "type": "string"
                },
                "createdDate": {
                  "format": "date-time",
                  "description": "The date this grade item score is created",
                  "type": "string"
                },
                "creatorID": {
                  "format": "uuid",
                  "description": "the ID of the user who created this grade item score",
                  "type": "string"
                },
                "creatorName": {
                  "description": "The name of the user who created the grade item score",
                  "type": "string"
                },
                "creatorUserID": {
                  "description": "The user ID of the user who created the grade item score",
                  "type": "string"
                },
                "creatorEmail": {
                  "description": "The email address of the user who created the grade item score",
                  "type": "string"
                },
                "lastUpdatedDate": {
                  "format": "date-time",
                  "description": "the date this grade item score is last edited",
                  "type": "string"
                },
                "lastUpdatedBy": {
                  "format": "uuid",
                  "description": "the ID of the user who edited this grade item score",
                  "type": "string"
                },
                "lastUpdatedByName": {
                  "description": "The name of the user who last updated the grade item score",
                  "type": "string"
                },
                "lastUpdatedByUserID": {
                  "description": "The user ID of the user who last updated the grade item score",
                  "type": "string"
                },
                "lastUpdatedByEmail": {
                  "description": "The email address of the user who last updated the grade item score",
                  "type": "string"
                }
              }
            }
          },
          "id": {
            "format": "uuid",
            "description": "identifier",
            "type": "string"
          },
          "parentID": {
            "format": "uuid",
            "description": "the parent ID if any.  For those contents which is the first level under the resource. the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "resourceID": {
            "format": "uuid",
            "description": "the folder ID  or tool ID which contains this file or url",
            "type": "string"
          },
          "publish": {
            "description": "the publish flag which determine whether the record is published to students.",
            "type": "boolean"
          },
          "name": {
            "description": "the name of the url or the file",
            "type": "string"
          },
          "url": {
            "description": "url address",
            "type": "string"
          },
          "description": {
            "description": "file description or url description",
            "type": "string"
          },
          "isCompulsory": {
            "description": "flag to indicate whether the file/url is a compulsory material",
            "type": "boolean"
          },
          "allowDownload": {
            "description": "indicate whether user can download the file. used in multimedia and lib admin",
            "type": "boolean"
          },
          "fileSize": {
            "format": "double",
            "description": "file size in bytes",
            "type": "number"
          },
          "fileFormat": {
            "description": "type of record, value could be: File, Audio, Video,Weblink",
            "type": "string"
          },
          "fileName": {
            "description": "the actual file name",
            "type": "string"
          },
          "hasComments": {
            "description": "indicate whether there are comments made on this file",
            "type": "boolean"
          },
          "streamUrlPath": {
            "description": "used for audio and video",
            "type": "string"
          },
          "creatorID": {
            "format": "uuid",
            "description": "the ID of the user who created this record",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "description": "The date this record is created",
            "type": "string"
          },
          "creatorName": {
            "description": "The name of the user who created the record",
            "type": "string"
          },
          "creatorUserID": {
            "description": "The user ID of the user who created the record",
            "type": "string"
          },
          "creatorEmail": {
            "description": "The email address of the user who created the record",
            "type": "string"
          },
          "creatorMatricNo": {
            "description": "The Matric Number or Student Number of the user who created the record",
            "type": "string"
          },
          "lastUpdatedDate": {
            "format": "date-time",
            "description": "the date this record is edited last time",
            "type": "string"
          },
          "lastUpdatedBy": {
            "format": "uuid",
            "description": "the ID of the user who edited this record last time",
            "type": "string"
          },
          "lastUpdatedByName": {
            "description": "The name of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByUserID": {
            "description": "The user ID of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByEmail": {
            "description": "The email address of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByMatricNo": {
            "description": "The Matric Number or Student Number of the user who last updated the record",
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "folders": [
    {
      "id": "string",
      "createdDate": "string",
      "creatorID": "string",
      "creatorName": "string",
      "creatorUserID": "string",
      "creatorEmail": "string",
      "lastUpdatedDate": "string",
      "lastUpdatedBy": "string",
      "lastUpdatedByName": "string",
      "lastUpdatedByUserID": "string",
      "lastUpdatedByEmail": "string",
      "name": "string",
      "startDate": "string",
      "endDate": "string",
      "publish": true,
      "parentID": "string",
      "rootID": "string",
      "feedbackReleaseDate": "string",
      "isActive": true,
      "parentFolderPath": "string",
      "sortFilesBy": "string",
      "allowUpload": true,
      "uploadDisplayOption": "string",
      "viewAll": true,
      "folderScore": 0.0,
      "allowComments": true,
      "allowAnnotate": true,
      "submissionDeadline": "string",
      "allowLateSubmission": true,
      "isTurnitinFolder": true,
      "allowedFileType": [
        "string"
      ],
      "allowedSubmissionFileTypes": [
        {
          "fileTypeName": "string",
          "extensions": [
            "string"
          ]
        }
      ]
    }
  ],
  "files": [
    {
      "comment": [
        {
          "fileRemarksAttachment": "string",
          "id": "string",
          "targetID": "string",
          "resourceID": "string",
          "publish": true,
          "mark": 0.0,
          "moderation": 0.0,
          "finalMark": 0.0,
          "remark": "string",
          "createdDate": "string",
          "creatorID": "string",
          "creatorName": "string",
          "creatorUserID": "string",
          "creatorEmail": "string",
          "lastUpdatedDate": "string",
          "lastUpdatedBy": "string",
          "lastUpdatedByName": "string",
          "lastUpdatedByUserID": "string",
          "lastUpdatedByEmail": "string"
        }
      ],
      "id": "string",
      "parentID": "string",
      "resourceID": "string",
      "publish": true,
      "name": "string",
      "url": "string",
      "description": "string",
      "isCompulsory": true,
      "allowDownload": true,
      "fileSize": 0.0,
      "fileFormat": "string",
      "fileName": "string",
      "hasComments": true,
      "streamUrlPath": "string",
      "creatorID": "string",
      "createdDate": "string",
      "creatorName": "string",
      "creatorUserID": "string",
      "creatorEmail": "string",
      "creatorMatricNo": "string",
      "lastUpdatedDate": "string",
      "lastUpdatedBy": "string",
      "lastUpdatedByName": "string",
      "lastUpdatedByUserID": "string",
      "lastUpdatedByEmail": "string",
      "lastUpdatedByMatricNo": "string"
    }
  ]
}
{
  "description": "searched folders, files and urls",
  "type": "object",
  "properties": {
    "folders": {
      "description": "searched folders",
      "type": "array",
      "items": {
        "description": "returned folder information",
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "identifier",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "description": "The date this record is created",
            "type": "string"
          },
          "creatorID": {
            "format": "uuid",
            "description": "the ID of the user who created this record",
            "type": "string"
          },
          "creatorName": {
            "description": "The name of the user who created the record",
            "type": "string"
          },
          "creatorUserID": {
            "description": "The user ID of the user who created the record",
            "type": "string"
          },
          "creatorEmail": {
            "description": "The email address of the user who created the record",
            "type": "string"
          },
          "lastUpdatedDate": {
            "format": "date-time",
            "description": "the date this record is edited last time",
            "type": "string"
          },
          "lastUpdatedBy": {
            "format": "uuid",
            "description": "the ID of the user who edited this record last time",
            "type": "string"
          },
          "lastUpdatedByName": {
            "description": "The name of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByUserID": {
            "description": "The user ID of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByEmail": {
            "description": "The email address of the user who last updated the record",
            "type": "string"
          },
          "name": {
            "description": "the name/title of the resource",
            "type": "string"
          },
          "startDate": {
            "format": "date-time",
            "description": "the date which this resource is open to students.",
            "type": "string"
          },
          "endDate": {
            "format": "date-time",
            "description": "the date which this resource is closed from students.",
            "type": "string"
          },
          "publish": {
            "description": "the publish flag which determin whether the resource is published to students.",
            "type": "boolean"
          },
          "parentID": {
            "format": "uuid",
            "description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "rootID": {
            "format": "uuid",
            "description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "feedbackReleaseDate": {
            "format": "date-time",
            "description": "the feedback release date used for turnitin folder.",
            "type": "string"
          },
          "isActive": {
            "description": "Indicate whether the folder is open or close",
            "type": "boolean",
            "readOnly": true
          },
          "parentFolderPath": {
            "description": "path of parent folder when populated",
            "type": "string"
          },
          "sortFilesBy": {
            "description": "the default sort columns when displaying files inside this folder, value can be : Date,Name,Owner,Size,Order",
            "type": "string"
          },
          "allowUpload": {
            "description": "flag to indicate whether students are allowed to submit documents to this folder",
            "type": "boolean"
          },
          "uploadDisplayOption": {
            "description": "The identity of the file uploader to be displayed, value can be : Matrix,Name,None",
            "type": "string"
          },
          "viewAll": {
            "description": "flag to indicate whether students can view documents uploaded by others",
            "type": "boolean"
          },
          "folderScore": {
            "format": "double",
            "description": "The full score assigned for this student submission folder, 0 means no marking on this assignment",
            "type": "number"
          },
          "allowComments": {
            "description": "allow student to comment",
            "type": "boolean"
          },
          "allowAnnotate": {
            "description": "allow student to view annotations, create annotations, reply annotations.",
            "type": "boolean"
          },
          "submissionDeadline": {
            "format": "date-time",
            "description": "The deadline which student are allowed to submit their document.StartDate --> SubmissionDeadline --> EndDate",
            "type": "string"
          },
          "allowLateSubmission": {
            "description": "allow student to submit their assignment after the deadline. Those submission will become late submission, used together with SubmissionDeadline",
            "type": "boolean"
          },
          "isTurnitinFolder": {
            "description": "true measn this folder is a turnitin submission folder",
            "type": "boolean"
          },
          "allowedFileType": {
            "description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "allowedSubmissionFileTypes": {
            "description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
            "type": "array",
            "items": {
              "description": "Name of the restrited file type",
              "required": [
                "fileTypeName"
              ],
              "type": "object",
              "properties": {
                "fileTypeName": {
                  "description": "Name of the file type",
                  "type": "string"
                },
                "extensions": {
                  "description": "file type extensions",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "files": {
      "description": "searched files",
      "type": "array",
      "items": {
        "description": "searched folders, files and urls",
        "required": [
          "description",
          "fileFormat",
          "fileName",
          "fileSize",
          "url"
        ],
        "type": "object",
        "properties": {
          "comment": {
            "description": "comments made on this file/weblink",
            "type": "array",
            "items": {
              "description": "the comment and scoring model",
              "type": "object",
              "properties": {
                "fileRemarksAttachment": {
                  "description": "the name of the file which attached to this comment",
                  "type": "string"
                },
                "id": {
                  "format": "uuid",
                  "description": "ID of the Mark/Comment",
                  "type": "string"
                },
                "targetID": {
                  "format": "uuid",
                  "description": "Target ID which this comment/mark for",
                  "type": "string"
                },
                "resourceID": {
                  "format": "uuid",
                  "description": "the folder ID  or tool ID which contains this comment/mark",
                  "type": "string"
                },
                "publish": {
                  "description": "the publish flag which determine whether the record is published to students.",
                  "type": "boolean"
                },
                "mark": {
                  "format": "float",
                  "description": "Marks entered for the student",
                  "type": "number"
                },
                "moderation": {
                  "format": "float",
                  "description": "Moderation entered for the student",
                  "type": "number"
                },
                "finalMark": {
                  "format": "float",
                  "description": "Final Mark for the student (computed column)",
                  "type": "number",
                  "readOnly": true
                },
                "remark": {
                  "description": "Remarks entered for the student",
                  "type": "string"
                },
                "createdDate": {
                  "format": "date-time",
                  "description": "The date this grade item score is created",
                  "type": "string"
                },
                "creatorID": {
                  "format": "uuid",
                  "description": "the ID of the user who created this grade item score",
                  "type": "string"
                },
                "creatorName": {
                  "description": "The name of the user who created the grade item score",
                  "type": "string"
                },
                "creatorUserID": {
                  "description": "The user ID of the user who created the grade item score",
                  "type": "string"
                },
                "creatorEmail": {
                  "description": "The email address of the user who created the grade item score",
                  "type": "string"
                },
                "lastUpdatedDate": {
                  "format": "date-time",
                  "description": "the date this grade item score is last edited",
                  "type": "string"
                },
                "lastUpdatedBy": {
                  "format": "uuid",
                  "description": "the ID of the user who edited this grade item score",
                  "type": "string"
                },
                "lastUpdatedByName": {
                  "description": "The name of the user who last updated the grade item score",
                  "type": "string"
                },
                "lastUpdatedByUserID": {
                  "description": "The user ID of the user who last updated the grade item score",
                  "type": "string"
                },
                "lastUpdatedByEmail": {
                  "description": "The email address of the user who last updated the grade item score",
                  "type": "string"
                }
              }
            }
          },
          "id": {
            "format": "uuid",
            "description": "identifier",
            "type": "string"
          },
          "parentID": {
            "format": "uuid",
            "description": "the parent ID if any.  For those contents which is the first level under the resource. the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "resourceID": {
            "format": "uuid",
            "description": "the folder ID  or tool ID which contains this file or url",
            "type": "string"
          },
          "publish": {
            "description": "the publish flag which determine whether the record is published to students.",
            "type": "boolean"
          },
          "name": {
            "description": "the name of the url or the file",
            "type": "string"
          },
          "url": {
            "description": "url address",
            "type": "string"
          },
          "description": {
            "description": "file description or url description",
            "type": "string"
          },
          "isCompulsory": {
            "description": "flag to indicate whether the file/url is a compulsory material",
            "type": "boolean"
          },
          "allowDownload": {
            "description": "indicate whether user can download the file. used in multimedia and lib admin",
            "type": "boolean"
          },
          "fileSize": {
            "format": "double",
            "description": "file size in bytes",
            "type": "number"
          },
          "fileFormat": {
            "description": "type of record, value could be: File, Audio, Video,Weblink",
            "type": "string"
          },
          "fileName": {
            "description": "the actual file name",
            "type": "string"
          },
          "hasComments": {
            "description": "indicate whether there are comments made on this file",
            "type": "boolean"
          },
          "streamUrlPath": {
            "description": "used for audio and video",
            "type": "string"
          },
          "creatorID": {
            "format": "uuid",
            "description": "the ID of the user who created this record",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "description": "The date this record is created",
            "type": "string"
          },
          "creatorName": {
            "description": "The name of the user who created the record",
            "type": "string"
          },
          "creatorUserID": {
            "description": "The user ID of the user who created the record",
            "type": "string"
          },
          "creatorEmail": {
            "description": "The email address of the user who created the record",
            "type": "string"
          },
          "creatorMatricNo": {
            "description": "The Matric Number or Student Number of the user who created the record",
            "type": "string"
          },
          "lastUpdatedDate": {
            "format": "date-time",
            "description": "the date this record is edited last time",
            "type": "string"
          },
          "lastUpdatedBy": {
            "format": "uuid",
            "description": "the ID of the user who edited this record last time",
            "type": "string"
          },
          "lastUpdatedByName": {
            "description": "The name of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByUserID": {
            "description": "The user ID of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByEmail": {
            "description": "The email address of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByMatricNo": {
            "description": "The Matric Number or Student Number of the user who last updated the record",
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "folders": [
    {
      "id": "string",
      "createdDate": "string",
      "creatorID": "string",
      "creatorName": "string",
      "creatorUserID": "string",
      "creatorEmail": "string",
      "lastUpdatedDate": "string",
      "lastUpdatedBy": "string",
      "lastUpdatedByName": "string",
      "lastUpdatedByUserID": "string",
      "lastUpdatedByEmail": "string",
      "name": "string",
      "startDate": "string",
      "endDate": "string",
      "publish": true,
      "parentID": "string",
      "rootID": "string",
      "feedbackReleaseDate": "string",
      "isActive": true,
      "parentFolderPath": "string",
      "sortFilesBy": "string",
      "allowUpload": true,
      "uploadDisplayOption": "string",
      "viewAll": true,
      "folderScore": 0.0,
      "allowComments": true,
      "allowAnnotate": true,
      "submissionDeadline": "string",
      "allowLateSubmission": true,
      "isTurnitinFolder": true,
      "allowedFileType": [
        "string"
      ],
      "allowedSubmissionFileTypes": [
        {
          "fileTypeName": "string",
          "extensions": [
            "string"
          ]
        }
      ]
    }
  ],
  "files": [
    {
      "comment": [
        {
          "fileRemarksAttachment": "string",
          "id": "string",
          "targetID": "string",
          "resourceID": "string",
          "publish": true,
          "mark": 0.0,
          "moderation": 0.0,
          "finalMark": 0.0,
          "remark": "string",
          "createdDate": "string",
          "creatorID": "string",
          "creatorName": "string",
          "creatorUserID": "string",
          "creatorEmail": "string",
          "lastUpdatedDate": "string",
          "lastUpdatedBy": "string",
          "lastUpdatedByName": "string",
          "lastUpdatedByUserID": "string",
          "lastUpdatedByEmail": "string"
        }
      ],
      "id": "string",
      "parentID": "string",
      "resourceID": "string",
      "publish": true,
      "name": "string",
      "url": "string",
      "description": "string",
      "isCompulsory": true,
      "allowDownload": true,
      "fileSize": 0.0,
      "fileFormat": "string",
      "fileName": "string",
      "hasComments": true,
      "streamUrlPath": "string",
      "creatorID": "string",
      "createdDate": "string",
      "creatorName": "string",
      "creatorUserID": "string",
      "creatorEmail": "string",
      "creatorMatricNo": "string",
      "lastUpdatedDate": "string",
      "lastUpdatedBy": "string",
      "lastUpdatedByName": "string",
      "lastUpdatedByUserID": "string",
      "lastUpdatedByEmail": "string",
      "lastUpdatedByMatricNo": "string"
    }
  ]
}
{
  "description": "searched folders, files and urls",
  "type": "object",
  "properties": {
    "folders": {
      "description": "searched folders",
      "type": "array",
      "items": {
        "description": "returned folder information",
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "identifier",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "description": "The date this record is created",
            "type": "string"
          },
          "creatorID": {
            "format": "uuid",
            "description": "the ID of the user who created this record",
            "type": "string"
          },
          "creatorName": {
            "description": "The name of the user who created the record",
            "type": "string"
          },
          "creatorUserID": {
            "description": "The user ID of the user who created the record",
            "type": "string"
          },
          "creatorEmail": {
            "description": "The email address of the user who created the record",
            "type": "string"
          },
          "lastUpdatedDate": {
            "format": "date-time",
            "description": "the date this record is edited last time",
            "type": "string"
          },
          "lastUpdatedBy": {
            "format": "uuid",
            "description": "the ID of the user who edited this record last time",
            "type": "string"
          },
          "lastUpdatedByName": {
            "description": "The name of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByUserID": {
            "description": "The user ID of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByEmail": {
            "description": "The email address of the user who last updated the record",
            "type": "string"
          },
          "name": {
            "description": "the name/title of the resource",
            "type": "string"
          },
          "startDate": {
            "format": "date-time",
            "description": "the date which this resource is open to students.",
            "type": "string"
          },
          "endDate": {
            "format": "date-time",
            "description": "the date which this resource is closed from students.",
            "type": "string"
          },
          "publish": {
            "description": "the publish flag which determin whether the resource is published to students.",
            "type": "boolean"
          },
          "parentID": {
            "format": "uuid",
            "description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "rootID": {
            "format": "uuid",
            "description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "feedbackReleaseDate": {
            "format": "date-time",
            "description": "the feedback release date used for turnitin folder.",
            "type": "string"
          },
          "isActive": {
            "description": "Indicate whether the folder is open or close",
            "type": "boolean",
            "readOnly": true
          },
          "parentFolderPath": {
            "description": "path of parent folder when populated",
            "type": "string"
          },
          "sortFilesBy": {
            "description": "the default sort columns when displaying files inside this folder, value can be : Date,Name,Owner,Size,Order",
            "type": "string"
          },
          "allowUpload": {
            "description": "flag to indicate whether students are allowed to submit documents to this folder",
            "type": "boolean"
          },
          "uploadDisplayOption": {
            "description": "The identity of the file uploader to be displayed, value can be : Matrix,Name,None",
            "type": "string"
          },
          "viewAll": {
            "description": "flag to indicate whether students can view documents uploaded by others",
            "type": "boolean"
          },
          "folderScore": {
            "format": "double",
            "description": "The full score assigned for this student submission folder, 0 means no marking on this assignment",
            "type": "number"
          },
          "allowComments": {
            "description": "allow student to comment",
            "type": "boolean"
          },
          "allowAnnotate": {
            "description": "allow student to view annotations, create annotations, reply annotations.",
            "type": "boolean"
          },
          "submissionDeadline": {
            "format": "date-time",
            "description": "The deadline which student are allowed to submit their document.StartDate --> SubmissionDeadline --> EndDate",
            "type": "string"
          },
          "allowLateSubmission": {
            "description": "allow student to submit their assignment after the deadline. Those submission will become late submission, used together with SubmissionDeadline",
            "type": "boolean"
          },
          "isTurnitinFolder": {
            "description": "true measn this folder is a turnitin submission folder",
            "type": "boolean"
          },
          "allowedFileType": {
            "description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "allowedSubmissionFileTypes": {
            "description": "List of file type which allowed when student upload their submissions. empty/null means no restriction on file type. Used only when student upload files to the non-turnitin submission folder.",
            "type": "array",
            "items": {
              "description": "Name of the restrited file type",
              "required": [
                "fileTypeName"
              ],
              "type": "object",
              "properties": {
                "fileTypeName": {
                  "description": "Name of the file type",
                  "type": "string"
                },
                "extensions": {
                  "description": "file type extensions",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "files": {
      "description": "searched files",
      "type": "array",
      "items": {
        "description": "searched folders, files and urls",
        "required": [
          "description",
          "fileFormat",
          "fileName",
          "fileSize",
          "url"
        ],
        "type": "object",
        "properties": {
          "comment": {
            "description": "comments made on this file/weblink",
            "type": "array",
            "items": {
              "description": "the comment and scoring model",
              "type": "object",
              "properties": {
                "fileRemarksAttachment": {
                  "description": "the name of the file which attached to this comment",
                  "type": "string"
                },
                "id": {
                  "format": "uuid",
                  "description": "ID of the Mark/Comment",
                  "type": "string"
                },
                "targetID": {
                  "format": "uuid",
                  "description": "Target ID which this comment/mark for",
                  "type": "string"
                },
                "resourceID": {
                  "format": "uuid",
                  "description": "the folder ID  or tool ID which contains this comment/mark",
                  "type": "string"
                },
                "publish": {
                  "description": "the publish flag which determine whether the record is published to students.",
                  "type": "boolean"
                },
                "mark": {
                  "format": "float",
                  "description": "Marks entered for the student",
                  "type": "number"
                },
                "moderation": {
                  "format": "float",
                  "description": "Moderation entered for the student",
                  "type": "number"
                },
                "finalMark": {
                  "format": "float",
                  "description": "Final Mark for the student (computed column)",
                  "type": "number",
                  "readOnly": true
                },
                "remark": {
                  "description": "Remarks entered for the student",
                  "type": "string"
                },
                "createdDate": {
                  "format": "date-time",
                  "description": "The date this grade item score is created",
                  "type": "string"
                },
                "creatorID": {
                  "format": "uuid",
                  "description": "the ID of the user who created this grade item score",
                  "type": "string"
                },
                "creatorName": {
                  "description": "The name of the user who created the grade item score",
                  "type": "string"
                },
                "creatorUserID": {
                  "description": "The user ID of the user who created the grade item score",
                  "type": "string"
                },
                "creatorEmail": {
                  "description": "The email address of the user who created the grade item score",
                  "type": "string"
                },
                "lastUpdatedDate": {
                  "format": "date-time",
                  "description": "the date this grade item score is last edited",
                  "type": "string"
                },
                "lastUpdatedBy": {
                  "format": "uuid",
                  "description": "the ID of the user who edited this grade item score",
                  "type": "string"
                },
                "lastUpdatedByName": {
                  "description": "The name of the user who last updated the grade item score",
                  "type": "string"
                },
                "lastUpdatedByUserID": {
                  "description": "The user ID of the user who last updated the grade item score",
                  "type": "string"
                },
                "lastUpdatedByEmail": {
                  "description": "The email address of the user who last updated the grade item score",
                  "type": "string"
                }
              }
            }
          },
          "id": {
            "format": "uuid",
            "description": "identifier",
            "type": "string"
          },
          "parentID": {
            "format": "uuid",
            "description": "the parent ID if any.  For those contents which is the first level under the resource. the parent ID value will be the same as the ID.",
            "type": "string"
          },
          "resourceID": {
            "format": "uuid",
            "description": "the folder ID  or tool ID which contains this file or url",
            "type": "string"
          },
          "publish": {
            "description": "the publish flag which determine whether the record is published to students.",
            "type": "boolean"
          },
          "name": {
            "description": "the name of the url or the file",
            "type": "string"
          },
          "url": {
            "description": "url address",
            "type": "string"
          },
          "description": {
            "description": "file description or url description",
            "type": "string"
          },
          "isCompulsory": {
            "description": "flag to indicate whether the file/url is a compulsory material",
            "type": "boolean"
          },
          "allowDownload": {
            "description": "indicate whether user can download the file. used in multimedia and lib admin",
            "type": "boolean"
          },
          "fileSize": {
            "format": "double",
            "description": "file size in bytes",
            "type": "number"
          },
          "fileFormat": {
            "description": "type of record, value could be: File, Audio, Video,Weblink",
            "type": "string"
          },
          "fileName": {
            "description": "the actual file name",
            "type": "string"
          },
          "hasComments": {
            "description": "indicate whether there are comments made on this file",
            "type": "boolean"
          },
          "streamUrlPath": {
            "description": "used for audio and video",
            "type": "string"
          },
          "creatorID": {
            "format": "uuid",
            "description": "the ID of the user who created this record",
            "type": "string"
          },
          "createdDate": {
            "format": "date-time",
            "description": "The date this record is created",
            "type": "string"
          },
          "creatorName": {
            "description": "The name of the user who created the record",
            "type": "string"
          },
          "creatorUserID": {
            "description": "The user ID of the user who created the record",
            "type": "string"
          },
          "creatorEmail": {
            "description": "The email address of the user who created the record",
            "type": "string"
          },
          "creatorMatricNo": {
            "description": "The Matric Number or Student Number of the user who created the record",
            "type": "string"
          },
          "lastUpdatedDate": {
            "format": "date-time",
            "description": "the date this record is edited last time",
            "type": "string"
          },
          "lastUpdatedBy": {
            "format": "uuid",
            "description": "the ID of the user who edited this record last time",
            "type": "string"
          },
          "lastUpdatedByName": {
            "description": "The name of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByUserID": {
            "description": "The user ID of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByEmail": {
            "description": "The email address of the user who last updated the record",
            "type": "string"
          },
          "lastUpdatedByMatricNo": {
            "description": "The Matric Number or Student Number of the user who last updated the record",
            "type": "string"
          }
        }
      }
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

403 Forbidden

Login user not authorized to perform this action

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://luminus.azure-api.net/files/{id}/search?SearchText={string}&populate={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["SearchText"] = "{string}";
            queryString["populate"] = "{string}";
            var uri = "https://luminus.azure-api.net/files/{id}/search?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/files/{id}/search");

            builder.setParameter("SearchText", "{string}");
            builder.setParameter("populate", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "SearchText": "{string}",
            "populate": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/files/{id}/search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://luminus.azure-api.net/files/{id}/search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"SearchText={string}",
                         @"populate={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/files/{id}/search');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'SearchText' => '{string}',
    'populate' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'SearchText': '{string}',
    'populate': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/files/{id}/search?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'SearchText': '{string}',
    'populate': '{string}',
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/files/{id}/search?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://luminus.azure-api.net/files/{id}/search')

query = URI.encode_www_form({
    # Request parameters
    'SearchText' => '{string}',
    'populate' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body