Does Idencia have an API I can use to integrate with other systems?

In this article, get an in depth description of Idencia's available API calls

Applicable Subscription Levels:   

STARTER  |  PRO  |  PRO+  |  ENTERPRISE

Overview

There are 5 basic tasks that can be performed via GET, POST and PUT calls to the Idencia Public API.

In this article, topics include:

Configuration

Get a List of Items

Get a List of Jobs

Create a New Item Type

Create a New Item

Create a New Job

Create a New Custom Item Type (within an existing Job)

Create a New Custom Property

Update an Existing Item

Update an Item's Custom Property

Update an Existing Job

Update an Item Type

Update a Custom Item Type (within a Job)

Also included at the end of this article is a downloadable file of Executable API Descriptions in the form of a JSON Postman App Collection.

• Postman collection

Configuration

Contact your customer liaison for instructions on configuring your site with an API key.

Get a List of Items

This call returns items that match the specified parameters.

Example:

https://<server name>.idencia.net/api/items?modifiedafter=<date and time>&jobNumber=<number>

• Where <server name> is the sub-domain name for the Idencia website
• Where <date and time> is a date/time formatted as "yyyy-MM-ddThh:mm:ss". The date and time should be converted to UTC time zone.
• Where <number> is the Job Number to which the items should belong

For the example call above, the API will return an XML tree of all Items in the specified Job that have been modified since the specified date and time.  

Response:

The format of the XML response will contain the following:

<ArrayOfItemType> - the top level of the returned list of items.

• <ItemType> - Under this tag is all of the information about the Item Type of this Item.
  • <Id> - The internal unique identifier for the item type.  This is a 16 byte GUID.
  • <Number> - The item type's Number field.
  • <Name> - The item type's Name field
  • <ModifiedOnServerUtc> - The UTC date/time stamp the item type was last modified on the server.
  • <CustomProperties> - Under this tag are all of the Item Type Custom Properties that have values.
    • <CustomProperty> - (multiple) - Under this tag will be Name and Value pairs for each Item Type Custom property that has a value
      • <Name> - The name of the Custom Property
      • <Value> - The value of the Custom Property

• • <Items> - Under this tag will be listed each item within the Item Type
    • <Item> (multiple) - a single item in the list of items that match the request parameters
      
      • <Id> - The internal unique identifier for the item.  This is a 16 byte GUID.
      • <IsDeleted> - A flag to indicate if the item has been deleted.  'true' if deleted, or 'false' if not deleted.
      • <ModifiedOnServerUtc> - The UTC date/time stamp the item was last modified on the server.
      • <CreatedById> - The unique identifier of the user who created the item.
      • <CreatedBy> - The first and last name of the user who created the item.
      • <CreatedOnUtc> - The UTC date/time stamp the item was created.
      • <CurrentPhase> - The name of the most recent Process Phase
      • <CustomProperties> - Under this tag are all of the Item Custom Properties that have values
        • <CustomProperty> - Under this tag will be Name and Value pairs for each Item Custom property that has a value
          • <Name> - The name of the Custom Property
          • <Value> - The value of the Custom Property
      • <HasFailedSteps> - A flag to indicate if the Item has Pass/Fail steps in the current process marked as Failed. 'true' if there are failed steps, 'false' if there are no failed steps.
      • <IsProcessComplete> - A flag to indicate if the Item is currently running a process or not.  'true' if no process is running, or 'false' if a process is running.
      • <SerialNumber> - The serial number assigned to the Item.
      • <ItemStatus> - The status of the Item
      • <CreatedOnSourceServerUtc> - The date/time the Item was created

• • • • <Process> (multiple) - Under this tag is all of the information about a process.  If more than one process has been run on an item, this tag is used for each process.
        • <Name> - The name of the Process.
        • <Phases> (multiple) - Under this tag are all of the Process Phases
          • <Phase> (multiple) - Under this tag are the Phase properties
            • <Name> - The name of the Phase
            • <Steps> - Under this tag are all of the steps in the Phase
              • <Step> (multiple) - This tag indicates a step within this phase of the process.
                • <Name> - The name of the step.
                • <StepType> - The type of step.  
                • <ModifiedOnServerUtc> - The UTC date/time stamp the step was last modified on the server.
                • <ModifiedById> - The unique identifier of the user who recorded the step.
                • <ModifiedBy> - The first and last name of the user who recorded the step.
                • <StepResult> - The recorded value of the step.
                  If Step Type is "Pass, Fail", result can be "Pass" or "Fail" or "N/A".
                  If Step type is "Set *Custom Property Name*", result is the value of the custom property
                • <ModifiedOnUtc> - The UTC date/time the step was recorded on the device.

In addition to the parameters listed above, there are two additional parameters that can be set in Azure that will affect the data returned by the API.

Item Grouping: The value of this parameter must be an Item Custom Property name.  If this setting is defined, the XML tree that is returned will include an <ItemGrouping> node for each different value of the custom property defined for the Item Grouping.  For example, if you have an Item Custom Property called "Inspection Date" and would like items in the XML tree to be grouped by Inspection Date, this setting can provide that grouping.

Get a List of Jobs

This call retrieves Jobs that match the specified parameters

Example:

URL: 

https://<server name>.idencia.net/api/jobs

• Where <server name> is the sub-domain name for the Idencia website

Example Body:  

For the example call above, the API will return an array of properties associated with the specified Job number.

The format of the returned JSON response will include the following:

• "Name" - The name of the Job
• "Number" - The number of the Job
• "CreatedOnUtc" - The date/time the Job was created
• "IsItemsLimited" - Are the items limited to the number required? (True/False)
• "CompletedStatus" - Is the Job complete? (True/False)
• "CompletionDate" - The date/time the Job was completed (if complete)
• "CustomerName" - The name of the Job's customer
• "ProcessName" - The name of the Job's default process
• "CustomProperties" - An array of custom property names and values
  • "CustomPropertyName" - The name of the custom property followed by the value

Create a New Item Type

This call will create a new Item Type (not job specific)

In this example an Item Type with the Number "Span A - 93-7 1/2" and Name "39x36 Box Beams" will be created. A large list of Custom Properties will be set for this Item Type.

{

Create a New Item

This call will create a new Item with the specified properties.

Example:

In this example, an Item with the Serial Number "123456789" will be created using the item type "C203509-Span A - 93-7 1/2".  Custom Properties "Concrete Mix", "Pour Date" and "Pour Number" are set to the associated values for this Item.

{
    "Key": "jj5693ec-17dc-4e27-accf-db840a76bfd7",
    "Number":"123456789",
    "ItemType":"C203509-Span A - 93-7 1/2",
    "Properties": [
        {
            "Name":"Concrete Mix",
            "Value":"24PVUNC785NVPSE"},
        {
            "Name":"Pour Date",
            "Value":"12/12/2015"},
        {
            "Name":"Pour Number",
            "Value":"1"}
    ]
}

Create a New Job

This call will insert a new Job.

Example:

In this example, a Job with the number 123456789 and name "Test Job 123456789" will be created with the settings and custom property values described in the code block below.  

Create a New Custom Item Type (within an existing Job)

This call will insert a new Custom Item Type within the specified Job.

Example:

Endpoint:   /api/CustomItemType/jDR556

In this example a Custom Item Type with the Number "BB-12A" and Name "Bridge Beam 12A" will be created in Job DR556. A large list of Custom Properties will be set for this Item Type.

Create a New Custom Property

This call will insert a new Custom Property of the specified type and category.

Endpoint:   /api/CustomProperty/Job

In this example a Text, Job Custom Property with the Name "Delivery Address".  This custom property will not appear in the mobile application.

{

Update an Existing Item

This call will update the Item Type, Job, and/or one or more Custom Properties of the specified Item.

Example:

{
    "key": "jj5693ec-17dc-4e27-accf-db840a76bfd7",  
    "number": "1558440247",
    "job":"test job",
    "itemtype": "test custom item type",
    "properties": [
        {
            "name": "Form ID",
            "value": "1"
        }
    ]
}

This call will update a single custom property for the specified Item.

Example:

This call will update one or more properties of the specified Job

Example:

Endpoint:   /api/Job/98765

{
    "key": "jj5693ec-17dc-4e27-accf-db840a76bfd7",
    "name": "Update Demo job 2",
    "customer": "",
    "IsItemsLimited": false, //true and false
    "IsCompleted": false, //true and false
    "defaultprocess": "NCR"
     }
}

This call will update one or more properties of the specified Item Type

Example:

/api/ItemType/123456

{
    "key": "jj5693ec-17dc-4e27-accf-db840a76bfd7",
    "name": "new Item Type name",
    "informationurl": "",
    "defaultprocess": "",
    "customproperties": {
          "design depth": 50,
          "design height": 110,
          "design length": 11,
          "material": "test"
     }
}

Update a Custom Item Type (within a Job)

This call will update one or more properties of the specified Custom Item Type

Example:

/api/CustomItemType/12345/9875

{
    "key": "jj5693ec-17dc-4e27-accf-db840a76bfd7",
    "name": "Updated Item Type name",
    "informationurl": "https://myintranetsite.com/ItemTypeInfo",
    "defaultprocess": "Pre Pour Inspection",
    "customproperties": {
          "design depth": 50,
          "design height": 110,
          "design length": 11,
          "material": "test"
     }
}

Postman collection

Click the link below to download a sample Postman Collection.

Idencia API - Postman Collection (JSON)