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": "1d586ec8-99cd-4792-9ffd-3b0f49113d77",
  "templateId": "bdb1d2f8-c3e9-4b4c-93d4-974abee84b98"
}

text/html

Sample: 
{"jobId":"1d586ec8-99cd-4792-9ffd-3b0f49113d77","templateId":"bdb1d2f8-c3e9-4b4c-93d4-974abee84b98"}

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.