POST api/JobTemplates

Request Information

URI Parameters

None.

Body Parameters

JobTemplateDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
CreationDate

date

Required
CreatedByUserId

globally unique identifier

None.
RenderType

RenderTypeDto

Required
SupplierId

globally unique identifier

None.
CronExpression

string

Required
JobInstances

Collection of JobInstanceDto

None.
WorkflowLocation

string

None.
CommandParameters

string

None.
TemplateId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "f7f1302e-ca9a-480a-8730-36653f6cf2f4",
  "CreationDate": "2025-12-10T23:36:00.5736312+00:00",
  "CreatedByUserId": "fdebf91c-cd9e-47ee-846c-70df0ca7c434",
  "RenderType": 0,
  "SupplierId": "1a68f330-14a4-4221-abe3-6f61691cbdec",
  "CronExpression": "sample string 5",
  "JobInstances": [
    {
      "Id": "139484d9-cfbf-41e4-9dd0-31f7c8a9b4cc",
      "CreationDate": "2025-12-10T23:36:00.5736312+00:00",
      "CreatedByUserId": "66665aca-8688-4602-8b7a-5ebb0b22c926",
      "ScheduledDate": "2025-12-10T23:36:00.5736312+00:00",
      "RecurringJobId": "55de9ed2-009e-4b73-89f0-e999a7e3bcb4",
      "RenderType": 0,
      "Status": 0,
      "StatusChangeLogs": [
        {
          "Id": "19203d83-6844-4a60-9534-68e4ddffdead",
          "UserId": "d45f50bd-c237-4dfe-9db8-c3ffb772363b",
          "Status": 0,
          "Comment": "sample string 3",
          "JobId": "f0859667-8870-4913-b655-361cbba9230b",
          "CreationDate": "2025-12-10T23:36:00.5736312+00:00"
        },
        {
          "Id": "19203d83-6844-4a60-9534-68e4ddffdead",
          "UserId": "d45f50bd-c237-4dfe-9db8-c3ffb772363b",
          "Status": 0,
          "Comment": "sample string 3",
          "JobId": "f0859667-8870-4913-b655-361cbba9230b",
          "CreationDate": "2025-12-10T23:36:00.5736312+00:00"
        }
      ],
      "XmlLocation": "sample string 6",
      "XmlDocument": {},
      "SupplierId": "e5c493d3-ff7d-4ab9-8174-b88fffc03a30",
      "OutputType": 0
    },
    {
      "Id": "139484d9-cfbf-41e4-9dd0-31f7c8a9b4cc",
      "CreationDate": "2025-12-10T23:36:00.5736312+00:00",
      "CreatedByUserId": "66665aca-8688-4602-8b7a-5ebb0b22c926",
      "ScheduledDate": "2025-12-10T23:36:00.5736312+00:00",
      "RecurringJobId": "55de9ed2-009e-4b73-89f0-e999a7e3bcb4",
      "RenderType": 0,
      "Status": 0,
      "StatusChangeLogs": [
        {
          "Id": "19203d83-6844-4a60-9534-68e4ddffdead",
          "UserId": "d45f50bd-c237-4dfe-9db8-c3ffb772363b",
          "Status": 0,
          "Comment": "sample string 3",
          "JobId": "f0859667-8870-4913-b655-361cbba9230b",
          "CreationDate": "2025-12-10T23:36:00.5736312+00:00"
        },
        {
          "Id": "19203d83-6844-4a60-9534-68e4ddffdead",
          "UserId": "d45f50bd-c237-4dfe-9db8-c3ffb772363b",
          "Status": 0,
          "Comment": "sample string 3",
          "JobId": "f0859667-8870-4913-b655-361cbba9230b",
          "CreationDate": "2025-12-10T23:36:00.5736312+00:00"
        }
      ],
      "XmlLocation": "sample string 6",
      "XmlDocument": {},
      "SupplierId": "e5c493d3-ff7d-4ab9-8174-b88fffc03a30",
      "OutputType": 0
    }
  ],
  "WorkflowLocation": "sample string 6",
  "CommandParameters": "sample string 7",
  "TemplateId": "d8ea8ed0-a1f7-4cdb-9a5b-4857382d78b3"
}

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 'JobTemplateDto'.

Response Information

Resource Description

None.