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": "4d5115f7-665a-49f8-93c7-9bab1e3224c0",
  "templateId": "6fac61dd-0fc6-44bf-acbd-79ca726f21dc"
}

text/html

Sample: 
{"jobId":"4d5115f7-665a-49f8-93c7-9bab1e3224c0","templateId":"6fac61dd-0fc6-44bf-acbd-79ca726f21dc"}

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.