Overview

For cases where plans or blueprints contain multiple variations or structures in one file, Hover's API provides to submit these files and subsequently build all the variations in a blueprint plan from one submission. This guide explains how to use Hover's API to submit a blueprint file and trigger the Build All feature programmatically.

Before You Start

While the majority of the Hover API endpoints reflect a RESTful architecture, this particular endpoint is a GraphQL mutation. For more information on Hover's GraphQL endpoints, including a tutorial on working with the Hover GraphQL playground, please consult this guide.

GraphQL Mutation

To initiate a Build All submission, construct your mutation to the example below:

Request URL

https://graph.hover.to/graphql

mutation CreateBlueprintSubmission(  
  $fileAttachmentsAttributes: [FileAttachmentArgs!]!,  
  $jobsAttributes: [JobCreateArgs!],  
  $name: String,  
  $buildAll: Boolean  
) {  
  createBlueprintSubmission(  
    fileAttachmentsAttributes: $fileAttachmentsAttributes  
    name: $name  
    jobsAttributes: $jobsAttributes  
    buildAll: $buildAll  
  ) {  
    createdAt  
    id  
    name  
    orgId  
    state  
    userId  
    __typename  
  }  
}

Required Variables

Below is an example of the variables required for the mutation:

{  
  "fileAttachmentsAttributes": [  
    {  
      "provider": "FileStack",  
      "url": "https://myURL.com/myfile",  
      "filename": "resuable_blueprint_plan_to_test.pdf",  
      "mimetype": "application/pdf",  
      "size": 5679689  
    }  
  ],  
  "buildAll": true,  
  "name": "resuableblueprint_plan_to_test"  
}

Explanation of Variables

• fileAttachmentsAttributes: An array of file attributes, including the file provider (e.g., FileStack), URL, filename, MIME type, and file size.
• buildAll: Boolean flag (true to process all blueprints within the file, false to process a single blueprint).
• name: A string representing the name of the blueprint submission.
• jobsAttributes (optional): If specified, allows creating jobs along with the blueprint submission.

Response Example

If the mutation executes successfully, the API will return a response like this:

{  
  "data": {  
    "createBlueprintSubmission": {  
      "createdAt": "2024-04-03T12:00:00Z",  
      "id": "123456",  
      "name": "resuableblueprint_plan_to_test",  
      "orgId": "78910",  
      "state": "PROCESSING",  
      "userId": "user_9876",  
      "\_\_typename": "BlueprintSubmission"  
    }  
  }  
}

Explanation of Response Fields

• createdAt: Timestamp when the submission was created.
• id: Unique identifier for the blueprint submission.
• name: Name assigned to the submission.
• orgId: Organization ID associated with the submission.
• state: Current state of the submission (e.g., PROCESSING, COMPLETED, FAILED).
• userId: The ID of the user who initiated the request.
• __typename: GraphQL type name.