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": "0dc0d1d1-d579-431f-8aa6-249d6cc6ef84",
  "templateId": "58624f8f-0256-4d49-95d0-8bb1bf86db6b"
}

text/html

Sample: 
{"jobId":"0dc0d1d1-d579-431f-8aa6-249d6cc6ef84","templateId":"58624f8f-0256-4d49-95d0-8bb1bf86db6b"}

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.