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.
Visibility	Defines visibility settings.	Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models.VisibilitySettings	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.
DeadlineSettings	Deadline settings.	Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models.DeadlineSettings	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.
MaxScore		decimal number	None.
IsAssessmentVisibleForStudents		boolean	None.
AddToAssessmentRecord		boolean	None.
AssessmentRecordCategoryId		integer	None.
TermId		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.
CompletionMode	Indicates whether submission of an answer is required for this assignment, or if it can be marked as completed without submission. ElementCompletionMode.ManualByTeacher and ElementCompletionMode.ManualByStudent means that assignment is in "task" mode, otherwise submission is required - standard old assignment functionality.	Itslearning.Platform.RestApi.Sdk.Common.Entities.ElementCompletionMode	None.
ExcludeFromTeacherTaskList	Defines whether to exclude from teacher's follow-up tasks or not.	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.
CustomLabelIds	Set of custom label IDs to associate with this assignment. Now it supports only one value If null or empty array, no custom label is associated. The custom labels are defined at site level, currently only supported for assignments.	Collection of 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",
  "Visibility": {
    "IsActive": true,
    "ActiveFrom": "2026-05-13T09:26:05Z",
    "ActiveTo": "2026-05-13T09:26:05Z"
  },
  "AssignTo": {
    "ParticipantIds": [
      1,
      2
    ],
    "GroupIds": [
      1,
      2
    ],
    "GroupName": "sample string 1"
  },
  "LearningObjectivesIds": [
    1,
    2
  ],
  "DeadlineSettings": {
    "Deadline": "2026-05-13T09:26:05Z",
    "IsSubmissionAfterDeadlineAllowed": true
  },
  "AssessmentStatusId": 1,
  "AssessmentId": 1,
  "MaxScore": 1.1,
  "IsAssessmentVisibleForStudents": true,
  "AddToAssessmentRecord": true,
  "AssessmentRecordCategoryId": 1,
  "TermId": 1,
  "IsAnonymous": true,
  "IsHomework": true,
  "IsMandatory": true,
  "CompletionMode": 1,
  "ExcludeFromTeacherTaskList": true,
  "Text": "sample string 3",
  "UsePlagiarismCheck": true,
  "ShowPlagiarismResultsToStudents": true,
  "SubmissionType": "Individual",
  "PeersToAssessCount": 1,
  "IsPeerAssessmentAnonymous": true,
  "IsSelfAssessmentRequired": true,
  "CustomLabelIds": [
    1,
    2
  ],
  "WorkloadEstimationInMinutes": 1,
  "Files": [
    {
      "FileRepoId": "sample string 1",
      "SignedFileRepoId": "sample string 2",
      "Name": "sample string 3",
      "MimeType": "sample string 4",
      "SourceType": 1
    },
    {
      "FileRepoId": "sample string 1",
      "SignedFileRepoId": "sample string 2",
      "Name": "sample string 3",
      "MimeType": "sample string 4",
      "SourceType": 1
    }
  ]
}

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">
  <AddToAssessmentRecord>true</AddToAssessmentRecord>
  <AssessmentId>1</AssessmentId>
  <AssessmentRecordCategoryId>1</AssessmentRecordCategoryId>
  <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:GroupName>sample string 1</d2p1:GroupName>
    <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>
  <CompletionMode>NotApplicable</CompletionMode>
  <CustomLabelIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CustomLabelIds>
  <DeadlineSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models">
    <d2p1:Deadline>2026-05-13T09:26:05Z</d2p1:Deadline>
    <d2p1:IsSubmissionAfterDeadlineAllowed>true</d2p1:IsSubmissionAfterDeadlineAllowed>
  </DeadlineSettings>
  <ExcludeFromTeacherTaskList>true</ExcludeFromTeacherTaskList>
  <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:SourceType>Dropbox</d2p1:SourceType>
    </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:SourceType>Dropbox</d2p1:SourceType>
    </d2p1:UploadedTempFile>
  </Files>
  <IsAnonymous>true</IsAnonymous>
  <IsAssessmentVisibleForStudents>true</IsAssessmentVisibleForStudents>
  <IsHomework>true</IsHomework>
  <IsMandatory>true</IsMandatory>
  <IsPeerAssessmentAnonymous>true</IsPeerAssessmentAnonymous>
  <IsSelfAssessmentRequired>true</IsSelfAssessmentRequired>
  <LearningObjectivesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LearningObjectivesIds>
  <MaxScore>1.1</MaxScore>
  <ParentFolderId>1</ParentFolderId>
  <PeersToAssessCount>1</PeersToAssessCount>
  <ShowPlagiarismResultsToStudents>true</ShowPlagiarismResultsToStudents>
  <SubmissionType>Individual</SubmissionType>
  <TermId>1</TermId>
  <Text>sample string 3</Text>
  <Title>sample string 2</Title>
  <UsePlagiarismCheck>true</UsePlagiarismCheck>
  <Visibility xmlns:d2p1="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.Element.Models">
    <d2p1:ActiveFrom>2026-05-13T09:26:05Z</d2p1:ActiveFrom>
    <d2p1:ActiveTo>2026-05-13T09:26:05Z</d2p1:ActiveTo>
    <d2p1:IsActive>true</d2p1:IsActive>
  </Visibility>
  <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>