POST restapi/personal/assignments/v1

Create a new assignment in a course, in a specific folder. This endpoint is currently not available using Oauth2.

Request Information

URI Parameters

None.

Body Parameters

Request with parameters required to create an assignment

Itsolutions.Itslearning.Web.RestApi.Personal.Assignment.Requests.CreateAssignmentRequest

Name	Description	Type	Additional information
ParentFolderId	The folder to create the assignment in (must be a folder in a course).	integer	None.
Title	The title of the assignment.	string	None.
IsActive	Set to true or false to make the element active or inactive. Or you can use and to set a time range when the element is active.	boolean	None.
ActiveFrom	Active from date and time in UTC. If set, the element will be active from this date. If is set, and this one is null, the element will be active until .	date	None.
ActiveTo	Active to date and time in UTC. If set, the element will be active until this date. If is set, and this one is null, the element will be active from and onwards.	date	None.
AssignTo	Defines who to assign the element (e.g. assignment) to (specific users and/or groups). If null, or if no specific Ids are provided, the assignment is assigned to all users in the parent folder.	Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models.AssignTo	None.
LearningObjectivesIds	List of learning objective IDs to associate with this assignment.	Collection of integer	None.
Deadline	Deadline date and time in UTC. If null, there is no deadline. See also .	date	None.
IsSubmissionAfterDeadlineAllowed	Defines whether submission after the deadline is allowed.	boolean	None.
AssessmentStatusId	The assessment status id ("not submitted", "completed" etc) used for the assignment, will be null if no status is used.	integer	None.
AssessmentId	The assessment id (grades / assessment scale) used for the assignment, will be null if assessment scale is not used.	integer	None.
IsAnonymous	Defines whether submission is anonymous.	boolean	None.
IsHomework	Defines whether the assignment is a homework assignment.	boolean	None.
IsMandatory	Defines whether submission is mandatory.	boolean	None.
Text	The description text for the assignment, which may contain HTML and embedded files (e.g. images).	string	None.
UsePlagiarismCheck	Defines whether answers will be checked for plagiarism. When true there are some restrictions on the files that can be uploaded. Will not be possible to set this to true if the customer does not have a plagiarism check service configured.	boolean	None.
ShowPlagiarismResultsToStudents	Defines whether plagiarism results will be shown to students. Depends on being true.	boolean	None.
SubmissionType	Submission type for the assignment	Itsolutions.Itslearning.Web.RestApi.Personal.Assignment.Enums.AssignmentSubmissionType	None.
PeersToAssessCount	How many students should each student peer assess. null means that peer assessment is not used.	integer	None.
IsPeerAssessmentAnonymous	Defines whether peer assessment is anonymous. Only relevant if is set.	boolean	None.
IsSelfAssessmentRequired	Defines whether self-assessment is required.	boolean	None.
IsAssessmentVisibleForStudents	Defines whether the assessment is visible for students.	boolean	None.
CustomLabelId	Set a custom label ID to associate with this assignment. If null (or equal to 0), no custom label is associated. The custom labels are defined at site level, currently only supported for assignments.	integer	None.
WorkloadEstimationInMinutes	Estimated workload in minutes for completing the assignment. If null, no estimation is set and "Workload" is not being used. Workload is an optional feature that must be enabled at site level to be visible in the UI.	integer	None.
Files	Attachments to be added to the assignment. Files (e.g. images) embedded in , should NOT be included here.	Collection of Itsolutions.Itslearning.Web.RestApi.Personal.FileUpload.UploadedTempFile	None.

Request Formats

application/json, text/json

Sample:

{
  "ParentFolderId": 1,
  "Title": "sample string 2",
  "IsActive": true,
  "ActiveFrom": "2026-02-03T09:16:08Z",
  "ActiveTo": "2026-02-03T09:16:08Z",
  "AssignTo": {
    "ParticipantIds": [
      1,
      2
    ],
    "GroupIds": [
      1,
      2
    ]
  },
  "LearningObjectivesIds": [
    1,
    2
  ],
  "Deadline": "2026-02-03T09:16:08Z",
  "IsSubmissionAfterDeadlineAllowed": true,
  "AssessmentStatusId": 1,
  "AssessmentId": 1,
  "IsAnonymous": true,
  "IsHomework": true,
  "IsMandatory": true,
  "Text": "sample string 7",
  "UsePlagiarismCheck": true,
  "ShowPlagiarismResultsToStudents": true,
  "SubmissionType": 0,
  "PeersToAssessCount": 1,
  "IsPeerAssessmentAnonymous": true,
  "IsSelfAssessmentRequired": true,
  "IsAssessmentVisibleForStudents": true,
  "CustomLabelId": 1,
  "WorkloadEstimationInMinutes": 1,
  "Files": [
    {
      "FileRepoId": "sample string 1",
      "SignedFileRepoId": "sample string 2",
      "Name": "sample string 3",
      "MimeType": "sample string 4"
    },
    {
      "FileRepoId": "sample string 1",
      "SignedFileRepoId": "sample string 2",
      "Name": "sample string 3",
      "MimeType": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<CreateAssignmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Assignment.Requests">
  <ActiveFrom>2026-02-03T09:16:08Z</ActiveFrom>
  <ActiveTo>2026-02-03T09:16:08Z</ActiveTo>
  <AssessmentId>1</AssessmentId>
  <AssessmentStatusId>1</AssessmentStatusId>
  <AssignTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models">
    <d2p1:GroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:GroupIds>
    <d2p1:ParticipantIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:ParticipantIds>
  </AssignTo>
  <CustomLabelId>1</CustomLabelId>
  <Deadline>2026-02-03T09:16:08Z</Deadline>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.FileUpload">
    <d2p1:UploadedTempFile>
      <d2p1:FileRepoId>sample string 1</d2p1:FileRepoId>
      <d2p1:MimeType>sample string 4</d2p1:MimeType>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
    </d2p1:UploadedTempFile>
    <d2p1:UploadedTempFile>
      <d2p1:FileRepoId>sample string 1</d2p1:FileRepoId>
      <d2p1:MimeType>sample string 4</d2p1:MimeType>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:SignedFileRepoId>sample string 2</d2p1:SignedFileRepoId>
    </d2p1:UploadedTempFile>
  </Files>
  <IsActive>true</IsActive>
  <IsAnonymous>true</IsAnonymous>
  <IsAssessmentVisibleForStudents>true</IsAssessmentVisibleForStudents>
  <IsHomework>true</IsHomework>
  <IsMandatory>true</IsMandatory>
  <IsPeerAssessmentAnonymous>true</IsPeerAssessmentAnonymous>
  <IsSelfAssessmentRequired>true</IsSelfAssessmentRequired>
  <IsSubmissionAfterDeadlineAllowed>true</IsSubmissionAfterDeadlineAllowed>
  <LearningObjectivesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LearningObjectivesIds>
  <ParentFolderId>1</ParentFolderId>
  <PeersToAssessCount>1</PeersToAssessCount>
  <ShowPlagiarismResultsToStudents>true</ShowPlagiarismResultsToStudents>
  <SubmissionType>Individual</SubmissionType>
  <Text>sample string 7</Text>
  <Title>sample string 2</Title>
  <UsePlagiarismCheck>true</UsePlagiarismCheck>
  <WorkloadEstimationInMinutes>1</WorkloadEstimationInMinutes>
</CreateAssignmentRequest>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>