CreateSubmissionAttributes schema

When a new submission is generated (such as through a call to POST /job/v1/submissions), the special schema definition CreateSubmissionAttributes is used. When retrieving the entity schema, the CreateSubmissionAttributes schema definition is included anytime the Job schema is retrieved. This means that any results that include the Job schema will also include the schema definition needed to know how to create a submission.

For example, the following commands will return the CreateSubmissionAttributes schema:

GET /common/v1/entity-schemas/Job
GET /common/v1/entity-schemas
GET /common/v1/entity-schemas?rootEntity:eq:Job

Response

…
"CreateSubmissionAttributes": {
  "description": "Details of the `Submission` job to create",
  "properties": {
    account": {
      "$ref": "#/definitions/SimpleReference",
      "description": "A reference to the `Account` that the policy is being created for",
      "title": "Account"
    },
    "baseState": {
      "$ref": "#/definitions/TypeKeyReference",
      "description": "The state or jurisdiction that the policy is based on",
      "title": "Base state",
      "x-gw-typelist": "Jurisdiction"
    },
    "dateQuoteNeeded": {
      "description": "The date that a quote for this submission is needed by",
      "format": "date",
      "nullable": true,
      "title": "Date quote needed",
      "type": "string"
    },
    …