POST api/jobs/generatedocumentation


Triggers a request to generate documentation for a job.

Request Information

URI Parameters

None.

Body Parameters

Details of the documentation required.

API.Domain.ViewModels.Job.JobDocumentationRequest
NameDescriptionTypeAdditional information
JobId

globally unique identifier

None.
TemplateId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "jobId": "b781adf8-5e63-450b-8cb1-2e277ba12d47",
  "templateId": "cd56906a-6bc4-4dc8-9173-1fcf9ca4ece0"
}

text/html

Sample: 
{"jobId":"b781adf8-5e63-450b-8cb1-2e277ba12d47","templateId":"cd56906a-6bc4-4dc8-9173-1fcf9ca4ece0"}

Response Information

Resource Description

200 if the request for documentation was successfully sent.

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.