POST api/jobs/uploadattachment


Endpoint for submitting job attachment meta data.

Request Information

URI Parameters

None.

Body Parameters

request body - the updated attachment meta data.

API.Infrastructure.Dto.Jobs.JobAttachmentMetaDataDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

JobId

globally unique identifier

Required

FileExtension

string

Required

Request Formats

application/json, text/json

Sample:
{
  "id": "6a3c341a-40ca-4538-a54a-c3d89653b94b",
  "jobId": "c2741cc1-d8f5-4191-b68a-d73212ca4381",
  "fileExtension": "sample string 2"
}

text/html

Sample:
{"id":"6a3c341a-40ca-4538-a54a-c3d89653b94b","jobId":"c2741cc1-d8f5-4191-b68a-d73212ca4381","fileExtension":"sample string 2"}

Response Information

Resource Description


HTTP 200
The updated add job attachment command, with the record id
if that wasn't supplied as part of the request.

HTTP 400
EntityDoesntExist - Job with id: xxx doesn't exist. It was probably deleted.
EntityDoesntExist - JobAttachment with id: xxx doesn't exist. It was probably deleted.
NoAttachmentIdProvidedException - No ID provided for job attachment.

HTTP 500
An error occurred, please try again or contact the administrator.

API.Commands.Job.Commands.UploadJobAttachmentMetadataCommand
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

JobId

globally unique identifier

None.

FileExtension

string

None.

CreatedBy

globally unique identifier

None.

TenantOrganisationId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "6e12ec78-bc26-4b8e-80b6-fd015ec4203d",
  "jobId": "723c8b6d-d57c-4742-a2b5-e458e3f28544",
  "fileExtension": "sample string 2",
  "createdBy": "81dc6fab-21ed-45ee-963b-f1e6fd166dc7",
  "tenantOrganisationId": "9f115ac5-e3b7-4d6d-82f6-9728c4b1be59"
}

text/html

Sample:
{"id":"6e12ec78-bc26-4b8e-80b6-fd015ec4203d","jobId":"723c8b6d-d57c-4742-a2b5-e458e3f28544","fileExtension":"sample string 2","createdBy":"81dc6fab-21ed-45ee-963b-f1e6fd166dc7","tenantOrganisationId":"9f115ac5-e3b7-4d6d-82f6-9728c4b1be59"}