Fortinet black logo

Jira Insight DB

Jira Insight DB v1.1.0

1.1.0
Copy Link
Copy Doc ID 9571b468-4d46-11ee-8e6d-fa163e15d75b:676

About the connector

Jira Insight gives teams a simple and quick way to tie assets and configuration items to service requests, incidents, problems, changes, and other issues to gain valuable context.

This document provides information about the Jira Insight DB Connector that facilitates automated interactions with a Jira Insight DB server using FortiSOAR™ playbooks. Add the Jira Insight DB Connector as a step in FortiSOAR™ playbooks and perform automated operations with Jira Insight DB.

Version information

Connector Version: 1.1.0

Authored By: Fortinet

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the Jira Insight DB Connector in version 1.1.0:

  • Added following new actions and playbooks:
    • Create Object
    • Update Object

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-jira-insight-db

Prerequisites to configuring the connector

  • You must have the credentials of Jira Insight DB server to which you will connect and perform automated operations.
  • The FortiSOAR™ server should have outbound connectivity to port 443 on the Jira Insight DB server.

Minimum Permissions Required

  • Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Jira Insight DB connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server URL URL for the Jira server to connect and perform automated operations.
Username Username configured for your account to access the Jira server to connect and perform automated operations.
API Token API Token configured for your account to access the Jira server to connect and perform automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set to True.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

Function Description Annotation and Category
Create Object Creates an object in Jira Insight server based on the Object ID, Object Type Attribute ID, Object Attribute Value, and other input parameters you have specified. create_object
Investigation
Update Object Updates an existing object in Jira Insight server based on the Object ID, Object Type Attribute ID, Object Attribute Value, and other input parameters you have specified. update_object
Investigation
Get Assets List Retrieves assets from the Jira server based on the Insight Query Language, page number, attributes, and other input parameters you have specified. get_assets
Investigation
Get Asset Details Retrieves details for a particular asset from the Jira server based on the asset ID you have specified. get_asset_details
Investigation
Get Asset Attributes Retrieves attributes for a particular asset from the Jira server based on the asset ID you have specified. get_asset_attributes
Investigation
Get Asset History Retrieves history for a particular asset from the Jira server based on the asset ID and sort order you have specified. get_asset_history
Investigation
Get Asset Reference Information Retrieves reference information for a particular asset from the Jira server based on the asset ID you have specified. get_asset_reference_info
Investigation
Get Asset Connected Tickets Retrieves the connected tickets for a particular asset from the Jira server based on the asset ID you have specified. get_asset_connected_tickets
Investigation

operation: Create Object

Input parameters

Parameter Description
Object Type ID Specify the object type ID that determines where the object should be stored and which attributes are available.
Object Type Attribute ID Specify the type of the attribute that decides how this value should be interpreted.
Object Attribute Values Specify the value to create the object in Jira Insight server.
Other Fields (Optional) Additional fields, in JSON format, that you want to add to the object being created in Jira Insight DB.

Output

The output contains the following populated JSON schema:

{
    "workspaceId": "",
    "globalId": "",
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "workspaceId": "",
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": "",
        "mediaClientConfig": {
            "clientId": "",
            "mediaBaseUrl": "",
            "mediaJwtToken": "",
            "fileId": ""
        }
    },
    "objectType": {
        "workspaceId": "",
        "globalId": "",
        "id": "",
        "name": "",
        "description": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "workspaceId": "",
            "globalId": "",
            "id": "",
            "objectTypeAttribute": {
                "workspaceId": "",
                "globalId": "",
                "id": "",
                "name": "",
                "label": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "indexed": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "displayValue": "",
                    "searchValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Update Object

Input parameters

Parameter Description
Object ID Specify the object ID that needs to be updated in Jira Insight server.
Object Type ID Specify the object type ID that determines where the object should be stored and which attributes are available.
Object Type Attribute ID Specify the type of the attribute that decides how this value should be interpreted.
Object Attribute Values Specify the value to update for the object in Jira Insight server.
Other Fields (Optional) Specify additional fields, in JSON format, that you want to update for the object being updated in Jira Insight DB.

Output

The output contains the following populated JSON schema:

{
    "workspaceId": "",
    "globalId": "",
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "workspaceId": "",
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": "",
        "mediaClientConfig": {
            "clientId": "",
            "mediaBaseUrl": "",
            "mediaJwtToken": "",
            "fileId": ""
        }
    },
    "objectType": {
        "workspaceId": "",
        "globalId": "",
        "id": "",
        "name": "",
        "description": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "workspaceId": "",
            "globalId": "",
            "id": "",
            "objectTypeAttribute": {
                "workspaceId": "",
                "globalId": "",
                "id": "",
                "name": "",
                "label": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "indexed": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "displayValue": "",
                    "searchValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Get Assets List

Input parameters

Parameter Description
Insight Query Language(IQL) Specify the query to determine the objects being fetched. E.g. objectType = "Computer". The empty IQL means all objects.
Page Number Specify the page to fetch when paginating through the response from your configured Jira server.
Result Per Page Specify the number of objects returned per page from your configured Jira server.
Include Attributes Specify whether the object attributes be included in the response. If this parameter is false, only the information on the object is returned and the object attributes are not present. By default, it is set to True.
Include Attributes Deep Specify the level depth of attributes to be included. For example, consider an object A that has a reference to object B that further has a reference to object C. If object A is included in the response and include attribute depth is set to 1 u.e.includeAttributesDeep=1, object A's reference to object B is included in the attributes of object A; however, object B's reference to object C is not included. To include object B's reference to object C object B's attributes set include attribute depth to 2 i.e. includeAttributesDeep=2.
Include Type Attributes Select to include the object type attribute definition for each attribute returned with the objects. By default, this parameter is set to False.
Include Extended Info Select to include the following information
  • open issues
  • if open issues are associated with objects
  • if objects have attachments
By default set to False.

Output

The output contains the following populated JSON schema:

{
    "objectEntries": [
        {
            "id": "",
            "label": "",
            "objectKey": "",
            "avatar": {
                "url16": "",
                "url48": "",
                "url72": "",
                "url144": "",
                "url288": "",
                "objectId": ""
            },
            "objectType": {
                "id": "",
                "name": "",
                "type": "",
                "icon": {
                    "id": "",
                    "name": "",
                    "url16": "",
                    "url48": ""
                },
                "position": "",
                "created": "",
                "updated": "",
                "objectCount": "",
                "objectSchemaId": "",
                "inherited": "",
                "abstractObjectType": "",
                "parentObjectTypeInherited": ""
            },
            "created": "",
            "updated": "",
            "hasAvatar": "",
            "timestamp": "",
            "attributes": [
                {
                    "id": "",
                    "objectTypeAttributeId": "",
                    "objectAttributeValues": [
                        {
                            "value": "",
                            "searchValue": "",
                            "displayValue": "",
                            "referencedType": ""
                        }
                    ],
                    "objectId": ""
                }
            ],
            "_links": {
                "self": ""
            },
            "name": ""
        }
    ],
    "objectTypeAttributes": [
        {
            "id": "",
            "name": "",
            "label": "",
            "type": "",
            "defaultType": {
                "id": "",
                "name": ""
            },
            "editable": "",
            "system": "",
            "sortable": "",
            "summable": "",
            "minimumCardinality": "",
            "maximumCardinality": "",
            "removable": "",
            "hidden": "",
            "includeChildObjectTypes": "",
            "uniqueAttribute": "",
            "options": "",
            "position": ""
        }
    ],
    "objectTypeId": "",
    "objectTypeIsInherited": "",
    "abstractObjectType": "",
    "totalFilterCount": "",
    "startIndex": "",
    "toIndex": "",
    "pageObjectSize": "",
    "pageNumber": "",
    "orderWay": "",
    "iql": "",
    "iqlSearchResult": "",
    "conversionPossible": "",
    "pageSize": ""
}

operation: Get Asset Details

Input parameters

Parameter Description
Asset ID Specify the asset ID whose information you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": ""
    },
    "objectType": {
        "id": "",
        "name": "",
        "type": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "id": "",
            "objectTypeAttribute": {
                "id": "",
                "name": "",
                "label": "",
                "type": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "searchValue": "",
                    "displayValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "extendedInfo": {
        "openIssuesExists": "",
        "attachmentsExists": ""
    },
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Get Asset Attributes

Input parameters

Parameter Description
Asset ID Specify the asset ID whose attributes you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": ""
    },
    "objectType": {
        "id": "",
        "name": "",
        "type": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "id": "",
            "objectTypeAttribute": {
                "id": "",
                "name": "",
                "label": "",
                "type": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "searchValue": "",
                    "displayValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "extendedInfo": {
        "openIssuesExists": "",
        "attachmentsExists": ""
    },
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Get Asset History

Input parameters

Parameter Description
Asset ID Specify the asset ID whose history you want to retrieve from your configured Jira server.
Sort in Ascending Order Select to sort parameter to retrieve history in ascending order from your configured Jira server. By default, set to True.
Abbreviate Select to abbreviate the history from your configured Jira server. By default, set to True.

Output

The output contains the following populated JSON schema:

[
    {
        "actor": {
            "avatarUrl": "",
            "displayName": "",
            "name": "",
            "key": "",
            "renderedLink": "",
            "isDeleted": ""
        },
        "id": "",
        "affectedAttribute": "",
        "oldValue": "",
        "newValue": "",
        "type": "",
        "created": "",
        "objectId": ""
    }
]

operation: Get Asset Reference Information

Input parameters

Parameter Description
Asset ID Specify the asset ID whose reference information you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

[
    {
        "referenceTypes": [
            {
                "id": "",
                "name": "",
                "description": "",
                "color": "",
                "url16": "",
                "removable": ""
            }
        ],
        "objectType": {
            "id": "",
            "name": "",
            "type": "",
            "icon": {
                "id": "",
                "name": "",
                "url16": "",
                "url48": ""
            },
            "position": "",
            "created": "",
            "updated": "",
            "objectCount": "",
            "objectSchemaId": "",
            "inherited": "",
            "abstractObjectType": "",
            "parentObjectTypeInherited": ""
        },
        "numberOfReferencedObjects": "",
        "openIssuesExists": ""
    }
]

operation: Get Asset Connected Tickets

Input parameters

Parameter Description
Asset ID Specify the asset ID whose connected tickets you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

{
    "tickets": [
        {
            "key": "",
            "id": "",
            "reporter": "",
            "created": "",
            "updated": "",
            "title": "",
            "status": {
                "name": "",
                "colorName": ""
            },
            "type": {
                "name": "",
                "description": "",
                "iconUrl": ""
            },
            "priority": {
                "name": "",
                "iconUrl": ""
            }
        }
    ],
    "allTicketsQuery": ""
}

Included playbooks

The Sample - Jira Insight DB - 1.1.0 playbook collection comes bundled with the Jira Insight DB connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Jira Insight DB connector.

  • Create Object
  • Get Asset Attributes
  • Get Asset Connected Tickets
  • Get Asset Details
  • Get Asset History
  • Get Asset Reference Information
  • Get Assets List
  • Update Object

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

Previous
Next

About the connector

Jira Insight gives teams a simple and quick way to tie assets and configuration items to service requests, incidents, problems, changes, and other issues to gain valuable context.

This document provides information about the Jira Insight DB Connector that facilitates automated interactions with a Jira Insight DB server using FortiSOAR™ playbooks. Add the Jira Insight DB Connector as a step in FortiSOAR™ playbooks and perform automated operations with Jira Insight DB.

Version information

Connector Version: 1.1.0

Authored By: Fortinet

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the Jira Insight DB Connector in version 1.1.0:

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-jira-insight-db

Prerequisites to configuring the connector

Minimum Permissions Required

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Jira Insight DB connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server URL URL for the Jira server to connect and perform automated operations.
Username Username configured for your account to access the Jira server to connect and perform automated operations.
API Token API Token configured for your account to access the Jira server to connect and perform automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set to True.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

Function Description Annotation and Category
Create Object Creates an object in Jira Insight server based on the Object ID, Object Type Attribute ID, Object Attribute Value, and other input parameters you have specified. create_object
Investigation
Update Object Updates an existing object in Jira Insight server based on the Object ID, Object Type Attribute ID, Object Attribute Value, and other input parameters you have specified. update_object
Investigation
Get Assets List Retrieves assets from the Jira server based on the Insight Query Language, page number, attributes, and other input parameters you have specified. get_assets
Investigation
Get Asset Details Retrieves details for a particular asset from the Jira server based on the asset ID you have specified. get_asset_details
Investigation
Get Asset Attributes Retrieves attributes for a particular asset from the Jira server based on the asset ID you have specified. get_asset_attributes
Investigation
Get Asset History Retrieves history for a particular asset from the Jira server based on the asset ID and sort order you have specified. get_asset_history
Investigation
Get Asset Reference Information Retrieves reference information for a particular asset from the Jira server based on the asset ID you have specified. get_asset_reference_info
Investigation
Get Asset Connected Tickets Retrieves the connected tickets for a particular asset from the Jira server based on the asset ID you have specified. get_asset_connected_tickets
Investigation

operation: Create Object

Input parameters

Parameter Description
Object Type ID Specify the object type ID that determines where the object should be stored and which attributes are available.
Object Type Attribute ID Specify the type of the attribute that decides how this value should be interpreted.
Object Attribute Values Specify the value to create the object in Jira Insight server.
Other Fields (Optional) Additional fields, in JSON format, that you want to add to the object being created in Jira Insight DB.

Output

The output contains the following populated JSON schema:

{
    "workspaceId": "",
    "globalId": "",
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "workspaceId": "",
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": "",
        "mediaClientConfig": {
            "clientId": "",
            "mediaBaseUrl": "",
            "mediaJwtToken": "",
            "fileId": ""
        }
    },
    "objectType": {
        "workspaceId": "",
        "globalId": "",
        "id": "",
        "name": "",
        "description": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "workspaceId": "",
            "globalId": "",
            "id": "",
            "objectTypeAttribute": {
                "workspaceId": "",
                "globalId": "",
                "id": "",
                "name": "",
                "label": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "indexed": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "displayValue": "",
                    "searchValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Update Object

Input parameters

Parameter Description
Object ID Specify the object ID that needs to be updated in Jira Insight server.
Object Type ID Specify the object type ID that determines where the object should be stored and which attributes are available.
Object Type Attribute ID Specify the type of the attribute that decides how this value should be interpreted.
Object Attribute Values Specify the value to update for the object in Jira Insight server.
Other Fields (Optional) Specify additional fields, in JSON format, that you want to update for the object being updated in Jira Insight DB.

Output

The output contains the following populated JSON schema:

{
    "workspaceId": "",
    "globalId": "",
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "workspaceId": "",
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": "",
        "mediaClientConfig": {
            "clientId": "",
            "mediaBaseUrl": "",
            "mediaJwtToken": "",
            "fileId": ""
        }
    },
    "objectType": {
        "workspaceId": "",
        "globalId": "",
        "id": "",
        "name": "",
        "description": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "workspaceId": "",
            "globalId": "",
            "id": "",
            "objectTypeAttribute": {
                "workspaceId": "",
                "globalId": "",
                "id": "",
                "name": "",
                "label": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "indexed": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "displayValue": "",
                    "searchValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Get Assets List

Input parameters

Parameter Description
Insight Query Language(IQL) Specify the query to determine the objects being fetched. E.g. objectType = "Computer". The empty IQL means all objects.
Page Number Specify the page to fetch when paginating through the response from your configured Jira server.
Result Per Page Specify the number of objects returned per page from your configured Jira server.
Include Attributes Specify whether the object attributes be included in the response. If this parameter is false, only the information on the object is returned and the object attributes are not present. By default, it is set to True.
Include Attributes Deep Specify the level depth of attributes to be included. For example, consider an object A that has a reference to object B that further has a reference to object C. If object A is included in the response and include attribute depth is set to 1 u.e.includeAttributesDeep=1, object A's reference to object B is included in the attributes of object A; however, object B's reference to object C is not included. To include object B's reference to object C object B's attributes set include attribute depth to 2 i.e. includeAttributesDeep=2.
Include Type Attributes Select to include the object type attribute definition for each attribute returned with the objects. By default, this parameter is set to False.
Include Extended Info Select to include the following information
  • open issues
  • if open issues are associated with objects
  • if objects have attachments
By default set to False.

Output

The output contains the following populated JSON schema:

{
    "objectEntries": [
        {
            "id": "",
            "label": "",
            "objectKey": "",
            "avatar": {
                "url16": "",
                "url48": "",
                "url72": "",
                "url144": "",
                "url288": "",
                "objectId": ""
            },
            "objectType": {
                "id": "",
                "name": "",
                "type": "",
                "icon": {
                    "id": "",
                    "name": "",
                    "url16": "",
                    "url48": ""
                },
                "position": "",
                "created": "",
                "updated": "",
                "objectCount": "",
                "objectSchemaId": "",
                "inherited": "",
                "abstractObjectType": "",
                "parentObjectTypeInherited": ""
            },
            "created": "",
            "updated": "",
            "hasAvatar": "",
            "timestamp": "",
            "attributes": [
                {
                    "id": "",
                    "objectTypeAttributeId": "",
                    "objectAttributeValues": [
                        {
                            "value": "",
                            "searchValue": "",
                            "displayValue": "",
                            "referencedType": ""
                        }
                    ],
                    "objectId": ""
                }
            ],
            "_links": {
                "self": ""
            },
            "name": ""
        }
    ],
    "objectTypeAttributes": [
        {
            "id": "",
            "name": "",
            "label": "",
            "type": "",
            "defaultType": {
                "id": "",
                "name": ""
            },
            "editable": "",
            "system": "",
            "sortable": "",
            "summable": "",
            "minimumCardinality": "",
            "maximumCardinality": "",
            "removable": "",
            "hidden": "",
            "includeChildObjectTypes": "",
            "uniqueAttribute": "",
            "options": "",
            "position": ""
        }
    ],
    "objectTypeId": "",
    "objectTypeIsInherited": "",
    "abstractObjectType": "",
    "totalFilterCount": "",
    "startIndex": "",
    "toIndex": "",
    "pageObjectSize": "",
    "pageNumber": "",
    "orderWay": "",
    "iql": "",
    "iqlSearchResult": "",
    "conversionPossible": "",
    "pageSize": ""
}

operation: Get Asset Details

Input parameters

Parameter Description
Asset ID Specify the asset ID whose information you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": ""
    },
    "objectType": {
        "id": "",
        "name": "",
        "type": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "id": "",
            "objectTypeAttribute": {
                "id": "",
                "name": "",
                "label": "",
                "type": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "searchValue": "",
                    "displayValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "extendedInfo": {
        "openIssuesExists": "",
        "attachmentsExists": ""
    },
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Get Asset Attributes

Input parameters

Parameter Description
Asset ID Specify the asset ID whose attributes you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

{
    "id": "",
    "label": "",
    "objectKey": "",
    "avatar": {
        "url16": "",
        "url48": "",
        "url72": "",
        "url144": "",
        "url288": "",
        "objectId": ""
    },
    "objectType": {
        "id": "",
        "name": "",
        "type": "",
        "icon": {
            "id": "",
            "name": "",
            "url16": "",
            "url48": ""
        },
        "position": "",
        "created": "",
        "updated": "",
        "objectCount": "",
        "objectSchemaId": "",
        "inherited": "",
        "abstractObjectType": "",
        "parentObjectTypeInherited": ""
    },
    "created": "",
    "updated": "",
    "hasAvatar": "",
    "timestamp": "",
    "attributes": [
        {
            "id": "",
            "objectTypeAttribute": {
                "id": "",
                "name": "",
                "label": "",
                "type": "",
                "defaultType": {
                    "id": "",
                    "name": ""
                },
                "editable": "",
                "system": "",
                "sortable": "",
                "summable": "",
                "minimumCardinality": "",
                "maximumCardinality": "",
                "removable": "",
                "hidden": "",
                "includeChildObjectTypes": "",
                "uniqueAttribute": "",
                "options": "",
                "position": ""
            },
            "objectTypeAttributeId": "",
            "objectAttributeValues": [
                {
                    "value": "",
                    "searchValue": "",
                    "displayValue": "",
                    "referencedType": ""
                }
            ],
            "objectId": ""
        }
    ],
    "extendedInfo": {
        "openIssuesExists": "",
        "attachmentsExists": ""
    },
    "_links": {
        "self": ""
    },
    "name": ""
}

operation: Get Asset History

Input parameters

Parameter Description
Asset ID Specify the asset ID whose history you want to retrieve from your configured Jira server.
Sort in Ascending Order Select to sort parameter to retrieve history in ascending order from your configured Jira server. By default, set to True.
Abbreviate Select to abbreviate the history from your configured Jira server. By default, set to True.

Output

The output contains the following populated JSON schema:

[
    {
        "actor": {
            "avatarUrl": "",
            "displayName": "",
            "name": "",
            "key": "",
            "renderedLink": "",
            "isDeleted": ""
        },
        "id": "",
        "affectedAttribute": "",
        "oldValue": "",
        "newValue": "",
        "type": "",
        "created": "",
        "objectId": ""
    }
]

operation: Get Asset Reference Information

Input parameters

Parameter Description
Asset ID Specify the asset ID whose reference information you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

[
    {
        "referenceTypes": [
            {
                "id": "",
                "name": "",
                "description": "",
                "color": "",
                "url16": "",
                "removable": ""
            }
        ],
        "objectType": {
            "id": "",
            "name": "",
            "type": "",
            "icon": {
                "id": "",
                "name": "",
                "url16": "",
                "url48": ""
            },
            "position": "",
            "created": "",
            "updated": "",
            "objectCount": "",
            "objectSchemaId": "",
            "inherited": "",
            "abstractObjectType": "",
            "parentObjectTypeInherited": ""
        },
        "numberOfReferencedObjects": "",
        "openIssuesExists": ""
    }
]

operation: Get Asset Connected Tickets

Input parameters

Parameter Description
Asset ID Specify the asset ID whose connected tickets you want to retrieve from your configured Jira server.

Output

The output contains the following populated JSON schema:

{
    "tickets": [
        {
            "key": "",
            "id": "",
            "reporter": "",
            "created": "",
            "updated": "",
            "title": "",
            "status": {
                "name": "",
                "colorName": ""
            },
            "type": {
                "name": "",
                "description": "",
                "iconUrl": ""
            },
            "priority": {
                "name": "",
                "iconUrl": ""
            }
        }
    ],
    "allTicketsQuery": ""
}

Included playbooks

The Sample - Jira Insight DB - 1.1.0 playbook collection comes bundled with the Jira Insight DB connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Jira Insight DB connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

Previous
Next