Anvil · JSON-LD Context

Anvil Context

JSON-LD context defining the semantic vocabulary for Anvil from Anvil.

4 Classes 24 Properties 3 Namespaces

View Context View on GitHub

Namespaces

xsd: http://www.w3.org/2001/XMLSchema#

schema: https://schema.org/

anvil: https://www.useanvil.com/docs/api/

Classes

Anvil AnvilAPI name description

Properties

Property	Type	Container
PDFTemplate	reference
EtchPacket	reference
Signer	reference
WebForm	reference
Workflow	reference
WebhookEvent	reference
pdfTemplateID	string
fieldAlias	string
versionNumber	integer
signingUrl	reference
apiKey	string
fillPdf
generatePdf
ocrExtraction
graphqlEndpoint	reference
graphqlSchema	reference
restEndpoint	reference
url	reference
documentation	reference
provider	reference
anvil:PDFFillingAPI
anvil:PDFGenerationAPI
anvil:EtchESignAPI
anvil:GraphQLAPI

JSON-LD Document

{
  "@context": {
    "@version": 1.1,
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "schema": "https://schema.org/",
    "anvil": "https://www.useanvil.com/docs/api/",

    "Anvil": "anvil:Anvil",
    "AnvilAPI": "anvil:AnvilAPI",

    "PDFTemplate": {
      "@id": "anvil:PDFTemplate",
      "@type": "@id"
    },
    "EtchPacket": {
      "@id": "anvil:EtchPacket",
      "@type": "@id"
    },
    "Signer": {
      "@id": "anvil:Signer",
      "@type": "@id"
    },
    "WebForm": {
      "@id": "anvil:WebForm",
      "@type": "@id"
    },
    "Workflow": {
      "@id": "anvil:Workflow",
      "@type": "@id"
    },
    "WebhookEvent": {
      "@id": "anvil:WebhookEvent",
      "@type": "@id"
    },

    "pdfTemplateID": {
      "@id": "anvil:pdfTemplateID",
      "@type": "xsd:string"
    },
    "fieldAlias": {
      "@id": "anvil:fieldAlias",
      "@type": "xsd:string"
    },
    "versionNumber": {
      "@id": "anvil:versionNumber",
      "@type": "xsd:integer"
    },
    "signingUrl": {
      "@id": "anvil:signingUrl",
      "@type": "@id"
    },
    "apiKey": {
      "@id": "anvil:apiKey",
      "@type": "xsd:string"
    },

    "fillPdf": {
      "@id": "anvil:fillPdf"
    },
    "generatePdf": {
      "@id": "anvil:generatePdf"
    },
    "ocrExtraction": {
      "@id": "anvil:ocrExtraction"
    },

    "graphqlEndpoint": {
      "@id": "anvil:graphqlEndpoint",
      "@type": "@id"
    },
    "graphqlSchema": {
      "@id": "anvil:graphqlSchema",
      "@type": "@id"
    },
    "restEndpoint": {
      "@id": "anvil:restEndpoint",
      "@type": "@id"
    },

    "name": "schema:name",
    "description": "schema:description",
    "url": {
      "@id": "schema:url",
      "@type": "@id"
    },
    "documentation": {
      "@id": "schema:documentation",
      "@type": "@id"
    },
    "provider": {
      "@id": "schema:provider",
      "@type": "@id"
    },

    "anvil:PDFFillingAPI": {
      "@id": "anvil:PDFFillingAPI",
      "restEndpoint": "https://app.useanvil.com/api/v1/fill/{pdfTemplateID}.pdf",
      "documentation": "https://www.useanvil.com/docs/api/fill-pdf/"
    },
    "anvil:PDFGenerationAPI": {
      "@id": "anvil:PDFGenerationAPI",
      "restEndpoint": "https://app.useanvil.com/api/v1/generate-pdf",
      "documentation": "https://www.useanvil.com/docs/api/generate-pdf/"
    },
    "anvil:EtchESignAPI": {
      "@id": "anvil:EtchESignAPI",
      "graphqlEndpoint": "https://app.useanvil.com/graphql",
      "documentation": "https://www.useanvil.com/docs/api/e-signatures/"
    },
    "anvil:GraphQLAPI": {
      "@id": "anvil:GraphQLAPI",
      "graphqlEndpoint": "https://app.useanvil.com/graphql",
      "graphqlSchema": "https://app.useanvil.com/graphql/sdl",
      "documentation": "https://www.useanvil.com/docs/api/graphql/"
    }
  }
}