POST api/JobInstances

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
CreationDate	date	Required
CreatedByUserId	globally unique identifier	None.
ScheduledDate	date	Required
RecurringJobId	globally unique identifier	None.
RenderType	RenderTypeDto	Required
Status	JobStatusDto	None.
StatusChangeLogs	Collection of JobStatusChangeLogDto	None.
XmlLocation	string	None.
XmlDocument	XDocument	None.
SupplierId	globally unique identifier	None.
OutputType	OutputTypeDto	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "00f830c1-8a4c-4449-a9a9-b36b0c1880e5",
  "CreationDate": "2026-01-10T01:15:09.6899796+00:00",
  "CreatedByUserId": "4352f33e-f03f-4603-a80c-8411fee04542",
  "ScheduledDate": "2026-01-10T01:15:09.6899796+00:00",
  "RecurringJobId": "e9c3c68b-399d-4595-a7e4-25ddaedba5aa",
  "RenderType": 0,
  "Status": 0,
  "StatusChangeLogs": [
    {
      "Id": "60b94a19-1268-485f-884a-d9762e2b3cd6",
      "UserId": "7d3d7d39-ef09-41df-86b4-c208ab0b6ecb",
      "Status": 0,
      "Comment": "sample string 3",
      "JobId": "5bea256e-8a76-4c88-8105-8613d08cda2b",
      "CreationDate": "2026-01-10T01:15:09.6899796+00:00"
    },
    {
      "Id": "60b94a19-1268-485f-884a-d9762e2b3cd6",
      "UserId": "7d3d7d39-ef09-41df-86b4-c208ab0b6ecb",
      "Status": 0,
      "Comment": "sample string 3",
      "JobId": "5bea256e-8a76-4c88-8105-8613d08cda2b",
      "CreationDate": "2026-01-10T01:15:09.6899796+00:00"
    }
  ],
  "XmlLocation": "sample string 6",
  "XmlDocument": {},
  "SupplierId": "9be096d1-52e8-4183-aab0-dc941ed0edda",
  "OutputType": 0
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Xml.Linq.XDeclaration' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Xml.Linq.XDeclaration' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'JobInstanceDto'.

Response Information

Resource Description

None.