DataLab actions

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "set-attribute";
        // Performs some additional validation during the process based on the supplied value.
        // This will default to 'string' when unspecified.
        "AttributeType": "string" | "integer" | "double" | "datetime";
        // This is a Nextspace path string.
        // Attribute path segments are separated by a forward slash. Eg: 'address/city'.
        "Path": string;
        // Value to set.
        "Value": any;
    }
}

interface IResponse {
    // ID of the Pending Action to monitor.
    ID: number;
}

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "layer";
        "Layer": {
            // Tags IDs.
            "OperandA": [1, 2, 3],
            // Operation we're performing.
            // 'add' will add the Tags to the Entity.
            // 'remove' will remove the Tags from the Entity.
            // 'set' will replace the Tags on the Entity with the supplied tags.
            "Operator": "add" | "remove" | "set";
        }
    }
}

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "attachclientfile";
        "AttachClientFile": {
            // ID of the file to attach.
            "ClientFile.ID": string;
            // Destination Attachment Type ID to attach the file to.
            "AttachmentType.ID": string;
            // Optional grouping within the related Attachment Type.
            // This is useful to further filter attachments within the same group.
            // Pass an empty string or null if you don't want to group the attachment.
            "Group": string;
        }
    }
}

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "export-json";
        // Optional expand property to expand additional data to the export.
        // Some options are "Attachment", "Tag", "LOD", "Relation", "EntityType".
        // Comma-separate if you want to do multiple, eg: "Attachment,Tag".
        "Expand"?: string;
        // Optional Scenario ID or Key to use for the export.
        // This will request the Scenario Entity data (if available) for the Entities.
        "Scenario?: string | number;
    }
}

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "export-csv";
        // ID of the Entity Type to reference for the schema definition.
        // Schema attributes marked as important/pinned will be included in the CSV.
        // The ID of the selection does not need to match this Type, however the schema should be compatible so you don't get empty rows.
        "EntityTypeID": string;
    }
}

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "delete";
    }
}

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "delete";
        // The ID of the Relation Type to delete.
        "RelationType.ID": string;
    }
}

interface IResponse {
    Items: {
        // ID of the transformation.
        // This is auto-generated for new records.
        "ID": number;
        // Human-readable name of the transformation.
        "Name": string;
        // Human-readable description of the transformation.
        "Description"?: string;
        // The ID of the Entity Type this transformation is for.
        "EntityType.ID": string;
        // Data Mapping to apply between the existing data to the newly saved data.
        // You have only to specify connections that you want changed.
        // See data mapping documentation for more information.
        "DataMapping": IDataMapping;
    }[];
}

interface IResponse {
    // ID of the transformation.
    // This is auto-generated for new records.
    "ID": number;
    // Human-readable name of the transformation.
    "Name": string;
    // Human-readable description of the transformation.
    "Description"?: string;
    // The ID of the Entity Type this transformation is for.
    "EntityType.ID": string;
    // Data Mapping to apply between the existing data to the newly saved data.
    // You have only to specify connections that you want changed.
    // See data mapping documentation for more information.
    "DataMapping": IDataMapping;
}

interface IResponse {
    // ID of the transformation.
    // This is auto-generated for new records.
    "ID"?: number;
    // Human-readable name of the transformation.
    "Name": string;
    // Human-readable description of the transformation.
    "Description"?: string;
    // The ID of the Entity Type this transformation is for.
    "EntityType.ID": string;
    // Data Mapping to apply between the existing data to the newly saved data.
    // You have only to specify connections that you want changed.
    // See data mapping documentation for more information.
    "DataMapping": IDataMapping;
}

interface IPostBody {
    "PrimarySelection": {
        "Items": any[];
    }
    "Action": {
        "ActionType": "data-transform";
        // ID of the transformation to apply.
        "DataTransformID": number;
    }
}