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": "ad9da947-0f11-4679-83ab-56a1dc2bbfc2",
  "templateId": "3735e7cf-e07e-4f2c-91f6-343ece0e963f"
}

text/html

Sample: 
{"jobId":"ad9da947-0f11-4679-83ab-56a1dc2bbfc2","templateId":"3735e7cf-e07e-4f2c-91f6-343ece0e963f"}

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.