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": "5a4a9cb6-d9f4-4051-8dfd-ca5193c7fe69",
  "templateId": "f113c8a1-ad31-433e-8ddc-a456cc143ae9"
}

text/html

Sample: 
{"jobId":"5a4a9cb6-d9f4-4051-8dfd-ca5193c7fe69","templateId":"f113c8a1-ad31-433e-8ddc-a456cc143ae9"}

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.