POST api/Suppliers

Request Information

URI Parameters

None.

Body Parameters

SupplierDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
CreationDate

date

Required
CreatedByUserId

globally unique identifier

None.
Name

string

Required

String length: inclusive between 0 and 250
TenantId

globally unique identifier

None.
SecurityGroup

globally unique identifier

None.
OutputType

OutputTypeDto

None.
EmailAddresses

string

Required
DirectoryLocation

string

None.
Url

string

None.
Username

string

None.
Password

string

None.
PortNumber

integer

None.
JobTemplates

Collection of JobTemplateDto

None.
CompressOutput

boolean

None.
JobTicketOutputFormat

JobTicketOutputFormatDto

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "46f23597-bbce-4e81-a4b3-d4135355b5da",
  "CreationDate": "2025-12-10T23:35:11.3938926+00:00",
  "CreatedByUserId": "fbb81ea6-1f17-4c85-a5e5-eea3c9e4032b",
  "Name": "sample string 4",
  "TenantId": "3c589775-e25c-4673-8274-d78392b9b892",
  "SecurityGroup": "2ba01f4b-7691-49c3-a11d-8e9f78b03567",
  "OutputType": 0,
  "EmailAddresses": "sample string 7",
  "DirectoryLocation": "sample string 8",
  "Url": "sample string 9",
  "Username": "sample string 10",
  "Password": "sample string 11",
  "PortNumber": 12,
  "JobTemplates": [
    {
      "Id": "4687ee41-b40d-4f5e-87d6-ab94e8ffd5c6",
      "CreationDate": "2025-12-10T23:35:11.3938926+00:00",
      "CreatedByUserId": "38052101-5c0b-4eca-9bd2-30391d5d97fb",
      "RenderType": 0,
      "SupplierId": "81bfd4f3-9cd9-4794-8d3c-36aaf18daf6a",
      "CronExpression": "sample string 5",
      "JobInstances": [
        {
          "Id": "ad511548-55da-4872-a3af-1214472c409e",
          "CreationDate": "2025-12-10T23:35:11.3938926+00:00",
          "CreatedByUserId": "a9c40333-c5e8-4c78-9c4b-39a30dcae4f2",
          "ScheduledDate": "2025-12-10T23:35:11.3938926+00:00",
          "RecurringJobId": "740326e5-1dce-4c65-93ff-89749bee5399",
          "RenderType": 0,
          "Status": 0,
          "StatusChangeLogs": [
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            },
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            }
          ],
          "XmlLocation": "sample string 6",
          "XmlDocument": {},
          "SupplierId": "22fafc20-17b2-4297-8f0d-f96b89c80b30",
          "OutputType": 0
        },
        {
          "Id": "ad511548-55da-4872-a3af-1214472c409e",
          "CreationDate": "2025-12-10T23:35:11.3938926+00:00",
          "CreatedByUserId": "a9c40333-c5e8-4c78-9c4b-39a30dcae4f2",
          "ScheduledDate": "2025-12-10T23:35:11.3938926+00:00",
          "RecurringJobId": "740326e5-1dce-4c65-93ff-89749bee5399",
          "RenderType": 0,
          "Status": 0,
          "StatusChangeLogs": [
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            },
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            }
          ],
          "XmlLocation": "sample string 6",
          "XmlDocument": {},
          "SupplierId": "22fafc20-17b2-4297-8f0d-f96b89c80b30",
          "OutputType": 0
        }
      ],
      "WorkflowLocation": "sample string 6",
      "CommandParameters": "sample string 7",
      "TemplateId": "8392e752-ab68-45dd-bf7d-bd91f3f88539"
    },
    {
      "Id": "4687ee41-b40d-4f5e-87d6-ab94e8ffd5c6",
      "CreationDate": "2025-12-10T23:35:11.3938926+00:00",
      "CreatedByUserId": "38052101-5c0b-4eca-9bd2-30391d5d97fb",
      "RenderType": 0,
      "SupplierId": "81bfd4f3-9cd9-4794-8d3c-36aaf18daf6a",
      "CronExpression": "sample string 5",
      "JobInstances": [
        {
          "Id": "ad511548-55da-4872-a3af-1214472c409e",
          "CreationDate": "2025-12-10T23:35:11.3938926+00:00",
          "CreatedByUserId": "a9c40333-c5e8-4c78-9c4b-39a30dcae4f2",
          "ScheduledDate": "2025-12-10T23:35:11.3938926+00:00",
          "RecurringJobId": "740326e5-1dce-4c65-93ff-89749bee5399",
          "RenderType": 0,
          "Status": 0,
          "StatusChangeLogs": [
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            },
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            }
          ],
          "XmlLocation": "sample string 6",
          "XmlDocument": {},
          "SupplierId": "22fafc20-17b2-4297-8f0d-f96b89c80b30",
          "OutputType": 0
        },
        {
          "Id": "ad511548-55da-4872-a3af-1214472c409e",
          "CreationDate": "2025-12-10T23:35:11.3938926+00:00",
          "CreatedByUserId": "a9c40333-c5e8-4c78-9c4b-39a30dcae4f2",
          "ScheduledDate": "2025-12-10T23:35:11.3938926+00:00",
          "RecurringJobId": "740326e5-1dce-4c65-93ff-89749bee5399",
          "RenderType": 0,
          "Status": 0,
          "StatusChangeLogs": [
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            },
            {
              "Id": "0e314a46-7283-4bde-961d-2fbb6cf7e422",
              "UserId": "502f17b6-7fbf-4bd1-94f0-af66e7440fc3",
              "Status": 0,
              "Comment": "sample string 3",
              "JobId": "81ba8717-7913-4914-a191-a324e62eeaf7",
              "CreationDate": "2025-12-10T23:35:11.3938926+00:00"
            }
          ],
          "XmlLocation": "sample string 6",
          "XmlDocument": {},
          "SupplierId": "22fafc20-17b2-4297-8f0d-f96b89c80b30",
          "OutputType": 0
        }
      ],
      "WorkflowLocation": "sample string 6",
      "CommandParameters": "sample string 7",
      "TemplateId": "8392e752-ab68-45dd-bf7d-bd91f3f88539"
    }
  ],
  "CompressOutput": true,
  "JobTicketOutputFormat": 1
}

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

Response Information

Resource Description

None.