IMPORTANT: Bulk upload triggers a data synchronization process that automatically updates or deletes entities/relationships as needed. Previously existing entities/relationships within the same
scope
that no longer exist in the latest upload will be marked for deletion.Therefore, the upload file should always include the complete set of entities or relationships within the defined
scope
to avoid unintended data deletion.In the UI, users are prompted to select/enter a
scope
when uploading a file.Via the API,
scope
is provided when starting a synchronization job.For example:
POST /persister/synchronization/jobs{ "source": "api", "scope": "my-sync-job" }See API doc for more details.
To successfully upload entity and relationship data, follow the schema outlined below:
{ "entities": [ { "_key": "1", "_type": "bulk_upload_entity", "_class": "EntityClass", "displayName": "Entity's displayName to show in UI", "owner": "Owner's name" // ...any other properties defined for the given type/class }, { "_key": "2", "_type": "bulk_upload_entity", "_class": "EntityClass", "displayName": "Entity's displayName to show in UI", "owner": "Owner's name" // ...any other properties defined for the given type/class }, ], "relationships": [ { "_key": "a", "_type": "bulk_upload_relationship", "_class": "VERB", "_fromEntityKey": "1", "_toEntityKey": "2" }, { "_key": "b", "_type": "bulk_upload_relationship", "_class": "VERB", "_fromEntityKey": "2", "_toEntityKey": "1" }, ] }
Entity Properties
Property | Type | Description |
---|---|---|
_key |
string |
A unique identifier/key for this entity within the scope defined by _scope . |
_type |
string |
User defined type for this entity. Value should be in snake_case . |
_class |
string or string[] |
The defined class for this entity. Value should be in TitleCase . |
owner |
string |
Identifier for the person/thing responsible for this entity. |
Properties with
_
prefix are reserved as JupiterOne system internal metadata properties. Other than_key
,_type
,_class
as listed above, any other property beginning with_
will be ignored when processing the upload.
Relationship Properties
Property | Type | Description |
---|---|---|
_key |
string |
A unique identifier/key for this relationship within the defined _scope . |
_type |
string |
User defined type for this relationship. Value should be in snake_case . |
_class |
string |
Relationship class. Typically a third-person singular verb such as HAS or MANAGES or ALLOWS . Value should be in CAPS . |
_fromEntityKey |
string |
The unique key for the entity on the "from" side of this relationship. |
_toEntityKey |
string |
The unique key for the entity on the "to" side of this relationship. |
Properties with
_
prefix are reserved as JupiterOne system internal metadata properties. Other than_key
,_type
,_class
,_fromEntityKey
, and_toEntityKey
as listed above, any other property beginning with_
will be ignored when processing the upload.
Comments
0 comments
Please sign in to leave a comment.