Export an octet stream of entities to be transformed into JSON by an API client, saved as a file, or exported to a different system.
API method: GET /v1/exportEntities
Example 1 -
Example 2 -
get_entitytreeselector (retrieving all entities that match type and their descendants)
Example 3 -
get_entitytreeselector (retrieving only direct descendants of startEntity that match type)
selector—enter one of the following options for entity selection.
search—search entities using a keyword (same behaviour as keyword search in GET /v1/searchByObjectTypes)
get_entitytree—retrieve entities and children based on types and object IDs
keyword—for use with the
searchselector. Return results that match specified keyword and provided type(s), or use "*" to retrieve all entities for the provided type(s).
startEntityId—for use with the
get_entitytreeselector. Provide the integer object ID for a specific entity to retrieve the entity and all of its descendants that match type(s) (unless
children_onlyis set to true). Default value is 1, the value to retrieve all entities and descendants that match the provided type(s).
children_only—(optional) for use with the
get_entitytreeselector. Set parameter to boolean value of true to return only the children of
startEntityIdand descendants beyond
startEntityId's immediate children will not be returned). If parameter is not provided or set to false, results will include
startEntityIdand all descendants (children of children and so on, recursively).
types—enter the types of entity to retrieve. Type(s) must be from Reference: exportEntities supported types
additionalExportFields—(optional) add this parameter with a value of
parentIdto include the parent ID of objects in the response.
forImport—(optional) add this parameter with a boolean value of true to export entities in a NDJSON format compatible with POST /v1/importEntitiesNote: The entities exported with
forImportset to true will still contain extra fields such as
state, which are not supported for v1/importEntities processing. Ensure that all unsupported fields are ignored by using the
ignoreFieldsquery parameter of v1/importEntities. Custom UDFs are supported as long as they are created in Address Manager before v1/importEntities processing.