{ "sections": [ "title", "description", "fields", "special_access_rules", "associated_objects" ], "title": "OrgSnapshot - Data API", "description": "Represents a snapshot of a scratch org. Snapshots capture the state of a scratch org so that you can use it to quickly spin up new scratch orgs using its configuration. This object is available in API version 61.0 and later.", "fields_columns": [ "type", "properties", "description", "relationship_name", "relationship_type", "refers_to" ], "fields": { "Content": { "type": "picklist", "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort", "description": "Reserved for future use." }, "Description": { "type": "textarea", "properties": "Create, Filter, Group, Nillable, Sort", "description": "A free-form text field (maximum 255 characters) for you to enter a description of this scratch org snapshot." }, "Error": { "type": "string", "properties": "Filter, Group, Nillable, Sort", "description": "Reserved for future use." }, "ExpirationDate": { "type": "date", "properties": "Filter, Group, Nillable, Sort", "description": "Date when the scratch org snapshot expires." }, "LastReferencedDate": { "type": "dateTime", "properties": "Filter, Nillable, Sort", "description": "The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record." }, "LastViewedDate": { "type": "dateTime", "properties": "Filter, Nillable, Sort", "description": "The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly." }, "OwnerId": { "type": "reference", "properties": "Create, Defaulted on create, Filter, Group, Sort, Update", "description": "The ID of the user who owns the scratch org snapshot. This field is a polymorphic relationship field.", "relationship_name": "Owner", "relationship_type": "Lookup", "refers_to": "Group, User" }, "Provider": { "type": "picklist", "properties": "Filter, Group, Restricted picklist, Sort", "description": "For internal use only." }, "ProviderSnapshot": { "type": "string", "properties": "Filter, Group, Nillable, Sort", "description": "For internal use only." }, "ProviderSnapshotVersion": { "type": "string", "properties": "Filter, Group, Sort", "description": "For internal use only." }, "SnapshotName": { "type": "string", "properties": "Create, Filter, Group, idLookup, Sort, Update", "description": "The name of the scratch org snapshot. This field value is unique within your org." }, "SourceOrg": { "type": "string", "properties": "Create, Filter, Group, Sort", "description": "The org ID of the scratch org that the snapshot was created from." }, "Status": { "type": "picklist", "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort", "description": "Status of the snapshot. Possible values are: Active—The snapshot is created and can be used to create scratch orgs. Error—The snapshot couldn’t be created. Expired—The snapshot has expired. In Progress—The snapshot is in the process of being created. New—The snapshot creation request has been received. The default value is New." } }, "special_access_rules": "A snapshot must belong to the Dev Hub org that you’re using to create the scratch org. You must enable the scratch org snapshot feature in your Dev Hub org using Setup.\n\nA snapshot must belong to the Dev Hub org that\n you’re using to create the scratch org. You must enable the scratch org snapshot feature in\n your Dev Hub org using Setup.", "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **OrgSnapshotFeed**: Feed tracking is available for the object.\n- **OrgSnapshotHistory**: History is available for tracked fields of the object.\n- **OrgSnapshotShare**: Sharing is available for the object." }