Getting FieldsID's

Getting Templates List

Using folioTemplates as a server you can see all of the id’s of the templates that your application can see, you can then use the id when creating a Folio to specify the template you are wanting to use. 

Request	Response
{  folioTemplates {    nodes {      id      name    }  } }	{  "data": {    "folioTemplates": {      "nodes": [        {          "id": "MDBDb250cmFjdFRlbXBsYXRlLTE0Mg",          "name": "Strategic Risks"        },         {          "id": "MDBDb250cmFjdFRlbXBsYXRlLTg",          "name": "Serious Incidents"        }      ]    }  } }

To find the id of a specific template (To find the fields on it for example) you can use the exactNames on the query to refine the search, see below for an example

Request	Response
{ folioTemplates(exactNames:"Incidents") {      nodes {        id        name      }     } }	{  "data": {    "folioTemplates": {      "nodes": [        {          "id": "MDBDLTE0Mg",          "name": "Incidents"        }      ]    }  } }

Getting Folio Field ID’s.

When creating or updating Folios you will need to pass the values you want in each field. You do that by using the fieldId which you get from using the folioFields query - which provides you with all of the fields on the template, their type, their name and its id that you then use when creating or updating Folios. 

Request

Response

{  folioFields {    edges {      node {        builtInFieldName        fieldType        id        libraryFieldId        lookupType        name        nodeType      }    }  } }

{ "data": {   "folioFields": {     "edges": [       {         "node": {           "id": "Field-576",           "builtInFieldName": null,           "fieldType": "long_text",           "lookupType": null           "name": "Additional Comments",           "nodeType": "field"         }       },       ...       {         "node": {           "id": "Field-578",           "builtInFieldName": null,           "fieldType": "date",           "lookupType": null,           "name": "Date Reported",           "nodeType": "field"         }       }     ]   } } }

Note - The above example is for a public link application. Below is an example for a server application where you need to specify which template you want the fields for 

Request

Response

{  folioFields(folioTemplateId:“DBMg") {   pageInfo { endCursor startCursor }    edges {      node {        builtInFieldName        fieldType        id        libraryFieldId        lookupType        name        nodeType      }    }  } }

{ "data": {   "folioFields": {    "pageInfo": { "endCursor": "MjU", "startCursor": "MQ" },     "edges": [       {         "node": {           "id": "Field-576",           "builtInFieldName": null,           "fieldType": "long_text",           "lookupType": null           "name": "Actions taken to resolve complaint",           "nodeType": "field"         }       },       ...       {         "node": {           "id": "Field-578",           "builtInFieldName": null,           "fieldType": "date",           "lookupType": null,           "name": "An Date Field",           "nodeType": "field"         }       }     ]   } } }

Getting Entity Fields

When creating or updating Entities you will need to pass the values you want in each field. You use the entityFields query to get the unique id for each field, an truncated example of the query is shown below. 

Request

Response

{  entityFields {    edges {      node {        id        name        fieldType        builtInFieldName        nodeType      }    }  } }

{  "data": {    "entityFields": {      "edges": [        {          "node": {            "id": "MDBGaWVsZC0zMA",            "name": "Name",            "fieldType": null,            "builtInFieldName": "name",            "nodeType": "field"          }        },        {          "node": {            "id": "MDBGaWVsZC0zMQ",            "name": "ABN",            "fieldType": null,            "builtInFieldName": "abn",            "nodeType": "field"          }        } ....        {          "node": {            "id": "MDBGaWVsZC0xODgw",            "name": "Entity Category",            "fieldType": null,            "builtInFieldName": "entity_category",            "nodeType": "field"          }        }      ]    }  } }

Getting Contact Fields

When creating or updating Contacts you will need to pass the values you want in each field. You use the contactFields query to get the unique id for each field - an truncated example of the query is shown below. 

Request

Response

{  contactFields {    edges {      node {        id        name        builtInFieldName        fieldType        nodeType        lookupType      }    }  } }

{  "data": {    "entityFields": {      "edges": [        {          "node": {            "id": "MDBGaWVsZC0zNw",            "name": "Lite User",            "builtInFieldName": "lite_user",            "fieldType": null,            "nodeType": "field",            "lookupType": null          }        },        {          "node": {            "id": "MDBGaWVsZC0zMA",            "name": "Address",            "fieldType": “address”,            "builtInFieldName": "name",            "nodeType": "field"          }        }      ]    }  } }

Breakdown of the Response

Folio Templates fields, Entity fields and Contact fields are made up of an graphql term called Edges. 

Each edge contains a node which is either a field, section or table. So the node is what we care about as it contains the information. 

A breakdown of what each of the items of a node is:

• builtInFieldName
  • Used to identify the BuiltInFieldName of the field so you know if it's one of Folio’s built in fields (will be null for all custom fields) - The built in fields do not have field types but are explained here
• fieldType
  • The field will have one of the following types of fields:
    • short_text
    • long_text
    • single_select
    • multi_select
    • numeric
    • date
    • time
    • url
    • attachments
    • address
    • scale
    • instructions
    • Email
• Id
  • The unique id of the field, and is what you use when sending a form back to Folio to identify the field.
• libraryFieldId
  • ID Used for the field when you are getting values from Folio
• lookupType
  • The lookup type will have one of the following types:
    • Location
    • Contact
    • Entity
    • User
    • BusinessUnit
    • Program
    • Folio
• Name
  • The name of the field in Folio
• nodeType
  • The type of node - is either a field, section or table.

Getting answers to single & multi select fields 

To get the answers for a single or multi select field you will use the fieldAnswers query which provides all of the answers for the field. You use the id to specify the answer you want when creating or updating a Folio. 

Request

Response

{ fieldAnswers(fieldId:"MDBGa0yMjk3") {   pageInfo {     endCursor     startCursor   }   edges {     node {       id       instructions       text       defaultAnswer       expanded     }   } } }

{  "data": {    "folioFields": {      "pageInfo": {        "endCursor": "MTAw",        "startCursor": "MQ"      },      "edges": [        {          "node": {            "id": "FieldAnswer-9786",            "instructions": null,            "text": "Apple",            "defaultAnswer": false,            "expanded": false          }        },        {          "node": {              "id": "FieldAnswer-9787",              "instructions": null,              "text": "Banana",              "defaultAnswer": true,              "expanded": false          }        }      ]    }  } }