Get Current Artifact Types and Relationships‎

POST /Command/GetCurrentArtifactTypesAndRelationships

This command is designed to return a JSON representation of all current artifact types within the D3 system, along with any existing relationships between these artifacts. This command is particularly useful for obtaining a comprehensive overview of the platform's data structure, including details about artifact types, their associated data model fields, and any defined relationships. The three parameters work as filters, and an AND relationship applies to them if more than one parameter is provided.

Request

Authentication: API keys or JSON web tokens (JWT)

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Artifact Category	`string`	Optional	This parameter specifies the artifact category to filter the desired artifact category: user-defined, system, or empty for all types. This parameter works as a filter, and an AND relationship applies to "Artifact Category", "Artifact Type ID", and "Artifact Type Name" if they are provided.
Artifact Type ID	`array<integer>`	Optional	This parameter specifies the artifact type IDs to filter the desired artifact types. If left empty, all types of artifact will be retrieved by default. This parameter works as a filter, and an AND relationship applies to "Artifact Category", "Artifact Type ID", and "Artifact Type Name" if they are provided. Optional: {“User Defined“, “System“}
Artifact Type Name	`array<string>`	Optional	This parameter specifies the artifact type names to filter the desired artifact types. If left empty, all types of artifact will be retrieved by default. This parameter works as a filter, and an AND relationship applies to "Artifact Category", "Artifact Type ID", and "Artifact Type Name" if they are provided.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Artifact Category": "System Defined",
    "Artifact Type ID": [
      15,
      16
    ],
    "Artifact Type Name": [
      "Username",
      "Filename"
    ]
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Data

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful",
        "Data": [
            {
                "AFTypeId": 15,
                "AFTypeName": "Username",
                "Type": "System",
                "IdentityFields": {
                    "General": [
                        {
                            "DataModelField": "Username",
                            "Role": "Username"
                        }
                    ],
                    "SourceSpecific": []
                },
                "AdditionalFields": [],
                "Relationships": []
            },
            {
                "AFTypeId": 16,
                "AFTypeName": "Filename",
                "Type": "System",
                "IdentityFields": {
                    "General": [
                        {
                            "DataModelField": "Filename",
                            "Role": "Filename"
                        }
                    ],
                    "SourceSpecific": []
                },
                "AdditionalFields": [],
                "Relationships": []
            }
        ]
    }
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}