# Models ## The PaginatedDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"PaginatedDto":{"type":"object","properties":{"total":{"type":"number","description":"Total number of entities."},"items":{"type":"array","items":{"type":"string"}}},"required":["total","items"]}}}} ``` ## The FindBackupsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FindBackupsResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string","description":"Backup or archive name."},"jobId":{"type":"number"},"jobStatus":{"type":"string","enum":["In Progress","Exception","Completed","Aborted"]},"startedDate":{"format":"date-time","type":"string"},"duration":{"type":"string"},"size":{"type":"number"},"records":{"type":"number"},"operationType":{"type":"string","enum":["Templated Archive","Templated Backup","Composite Backup","Composite & Sync Backup","Import Archive","Import Backup"]}},"required":["id","name","jobId","jobStatus","startedDate","duration","size","records","operationType"]}}}} ``` ## The ValidationExceptionDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"ValidationExceptionDto":{"type":"object","properties":{"error":{"type":"string","nullable":true},"message":{"type":"array","items":{"type":"string"}},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,424,428,429,500,501,502,503,504,505]}},"required":["error","message","statusCode"]}}}} ``` ## The NotFoundExceptionDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"NotFoundExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,424,428,429,500,501,502,503,504,505]}},"required":["message","error","statusCode"]}}}} ``` ## The BackupSettingsDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"BackupSettingsDto":{"type":"object","properties":{"isIncludeMetadata":{"type":"boolean"},"isIncludeBinaryObjects":{"type":"boolean"},"isIncludeBigObjects":{"type":"boolean"},"isIncludeFeedObjects":{"type":"boolean"},"isIncludeShareObjects":{"type":"boolean"},"isIncludeHistoryObjects":{"type":"boolean"},"isIncludeCustomMetadataTypeObjects":{"type":"boolean"},"isIncludeTagObjects":{"type":"boolean"},"templateId":{"type":"number"}},"required":["isIncludeMetadata","isIncludeBinaryObjects","isIncludeBigObjects","isIncludeFeedObjects","isIncludeShareObjects","isIncludeHistoryObjects","isIncludeCustomMetadataTypeObjects","isIncludeTagObjects"]}}}} ``` ## The CreateBackupBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"CreateBackupBodyDto":{"type":"object","properties":{"name":{"type":"string","description":"Backup or archive name."},"description":{"type":"string"},"settings":{"$ref":"#/components/schemas/BackupSettingsDto"},"mode":{"type":"string","enum":["full","template"]}},"required":["name","description","settings","mode"]},"BackupSettingsDto":{"type":"object","properties":{"isIncludeMetadata":{"type":"boolean"},"isIncludeBinaryObjects":{"type":"boolean"},"isIncludeBigObjects":{"type":"boolean"},"isIncludeFeedObjects":{"type":"boolean"},"isIncludeShareObjects":{"type":"boolean"},"isIncludeHistoryObjects":{"type":"boolean"},"isIncludeCustomMetadataTypeObjects":{"type":"boolean"},"isIncludeTagObjects":{"type":"boolean"},"templateId":{"type":"number"}},"required":["isIncludeMetadata","isIncludeBinaryObjects","isIncludeBigObjects","isIncludeFeedObjects","isIncludeShareObjects","isIncludeHistoryObjects","isIncludeCustomMetadataTypeObjects","isIncludeTagObjects"]}}}} ``` ## The CreateBackupResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"CreateBackupResponseDto":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The ConflictExceptionDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"ConflictExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,424,428,429,500,501,502,503,504,505]}},"required":["message","error","statusCode"]}}}} ``` ## The StreamableFile object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"StreamableFile":{"type":"object","properties":{}}}}} ``` ## The FieldDescribe object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FieldDescribe":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"isRequired":{"type":"boolean"},"isFilterable":{"type":"boolean"},"createable":{"type":"boolean"},"defaultedOnCreate":{"type":"boolean"},"nillable":{"type":"boolean"}},"required":["name","label","type","isRequired","isFilterable"]}}}} ``` ## The DeclarativeFilterLine object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"DeclarativeFilterLine":{"type":"object","properties":{"field":{"type":"string"},"label":{"type":"string"},"option":{"type":"string","enum":["equals","not equals","less than","greater than","less or equals","greater or equals","contains","does not contain","starts with","includes","excludes","in","not in"]},"value":{"type":"string"}},"required":["field","label","option","value"]}}}} ``` ## The TemplateStep object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"TemplateStep":{"type":"object","properties":{"relationshipName":{"type":"string"},"objectApiName":{"type":"string"},"label":{"type":"string"},"filterMode":{"type":"string","enum":["soql","declarative"]},"fieldsDescribe":{"type":"array","items":{"$ref":"#/components/schemas/FieldDescribe"}},"soqlFilter":{"type":"string"},"customLogic":{"type":"string"},"declarativeFilter":{"type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLine"}},"skipRemove":{"type":"boolean"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TemplateStep"}}},"required":["objectApiName","label","filterMode","fieldsDescribe","children"]},"FieldDescribe":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"isRequired":{"type":"boolean"},"isFilterable":{"type":"boolean"},"createable":{"type":"boolean"},"defaultedOnCreate":{"type":"boolean"},"nillable":{"type":"boolean"}},"required":["name","label","type","isRequired","isFilterable"]},"DeclarativeFilterLine":{"type":"object","properties":{"field":{"type":"string"},"label":{"type":"string"},"option":{"type":"string","enum":["equals","not equals","less than","greater than","less or equals","greater or equals","contains","does not contain","starts with","includes","excludes","in","not in"]},"value":{"type":"string"}},"required":["field","label","option","value"]}}}} ``` ## The CreateTemplateBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"CreateTemplateBodyDto":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["backup","archive"]},"description":{"type":"string"},"templateSteps":{"type":"array","items":{"$ref":"#/components/schemas/TemplateStep"}}},"required":["name","type","templateSteps"]},"TemplateStep":{"type":"object","properties":{"relationshipName":{"type":"string"},"objectApiName":{"type":"string"},"label":{"type":"string"},"filterMode":{"type":"string","enum":["soql","declarative"]},"fieldsDescribe":{"type":"array","items":{"$ref":"#/components/schemas/FieldDescribe"}},"soqlFilter":{"type":"string"},"customLogic":{"type":"string"},"declarativeFilter":{"type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLine"}},"skipRemove":{"type":"boolean"},"children":{"type":"array","items":{"$ref":"#/components/schemas/TemplateStep"}}},"required":["objectApiName","label","filterMode","fieldsDescribe","children"]},"FieldDescribe":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"isRequired":{"type":"boolean"},"isFilterable":{"type":"boolean"},"createable":{"type":"boolean"},"defaultedOnCreate":{"type":"boolean"},"nillable":{"type":"boolean"}},"required":["name","label","type","isRequired","isFilterable"]},"DeclarativeFilterLine":{"type":"object","properties":{"field":{"type":"string"},"label":{"type":"string"},"option":{"type":"string","enum":["equals","not equals","less than","greater than","less or equals","greater or equals","contains","does not contain","starts with","includes","excludes","in","not in"]},"value":{"type":"string"}},"required":["field","label","option","value"]}}}} ``` ## The CreateTemplateResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"CreateTemplateResponseDto":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The FindAllTemplatesRowDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FindAllTemplatesRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string","enum":["backup","archive"]},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","name","type","updatedAt"]}}}} ``` ## The FindAllTemplatesResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FindAllTemplatesResponseDto":{"type":"object","properties":{"total":{"type":"number","description":"Total number of entities."},"items":{"type":"array","items":{"$ref":"#/components/schemas/FindAllTemplatesRowDto"}},"backupTemplatesCount":{"type":"number"},"archiveTemplatesCount":{"type":"number"}},"required":["total","items","backupTemplatesCount","archiveTemplatesCount"]},"FindAllTemplatesRowDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string","enum":["backup","archive"]},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","name","type","updatedAt"]}}}} ``` ## The RootDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"RootDto":{"type":"object","properties":{"relationshipName":{"type":"string"},"objectApiName":{"type":"string"},"label":{"type":"string"},"soqlFilter":{"type":"string"},"customLogic":{"type":"string"},"declarativeFilter":{"type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLine"}},"skipRemove":{"type":"boolean"},"id":{"type":"number"},"level":{"type":"number"},"filterMode":{"type":"string","enum":["soql","declarative"]},"parentId":{"type":"number"}},"required":["objectApiName","label","id","level"]},"DeclarativeFilterLine":{"type":"object","properties":{"field":{"type":"string"},"label":{"type":"string"},"option":{"type":"string","enum":["equals","not equals","less than","greater than","less or equals","greater or equals","contains","does not contain","starts with","includes","excludes","in","not in"]},"value":{"type":"string"}},"required":["field","label","option","value"]}}}} ``` ## The FindOneTemplateResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FindOneTemplateResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string","enum":["backup","archive"]},"description":{"type":"string"},"roots":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/RootDto"}}}},"required":["id","name","type","roots"]},"RootDto":{"type":"object","properties":{"relationshipName":{"type":"string"},"objectApiName":{"type":"string"},"label":{"type":"string"},"soqlFilter":{"type":"string"},"customLogic":{"type":"string"},"declarativeFilter":{"type":"array","items":{"$ref":"#/components/schemas/DeclarativeFilterLine"}},"skipRemove":{"type":"boolean"},"id":{"type":"number"},"level":{"type":"number"},"filterMode":{"type":"string","enum":["soql","declarative"]},"parentId":{"type":"number"}},"required":["objectApiName","label","id","level"]},"DeclarativeFilterLine":{"type":"object","properties":{"field":{"type":"string"},"label":{"type":"string"},"option":{"type":"string","enum":["equals","not equals","less than","greater than","less or equals","greater or equals","contains","does not contain","starts with","includes","excludes","in","not in"]},"value":{"type":"string"}},"required":["field","label","option","value"]}}}} ``` ## The ConnectionFindResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"ConnectionFindResponseDto":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"number"},"name":{"type":"string","description":"Connection name"},"userName":{"type":"string","description":"Username for authenticating the connection."},"salesforceOrgType":{"type":"string","enum":["PRODUCTION","SANDBOX"],"description":"Salesforce organization type: SANDBOX or PRODUCTION"}},"required":["id","externalId","name","userName","salesforceOrgType"]}}}} ``` ## The ConnectionFindByIdResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"ConnectionFindByIdResponseDto":{"type":"object","properties":{"id":{"type":"number"},"externalId":{"type":"number"},"name":{"type":"string","description":"Connection name"},"userFullName":{"type":"string","description":"Full name of user for authenticating the connection."},"userName":{"type":"string","description":"Username for authenticating the connection."},"salesforceOrgId":{"type":"string","description":"Salesforce organization ID"},"salesforceOrgType":{"type":"string","enum":["PRODUCTION","SANDBOX"],"description":"Salesforce organization type: SANDBOX or PRODUCTION"}},"required":["id","externalId","name","userFullName","userName","salesforceOrgId","salesforceOrgType"]}}}} ``` ## The GetConnectionIdBySalesforceOrgIdResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"GetConnectionIdBySalesforceOrgIdResponseDto":{"type":"object","properties":{"connectionId":{"type":"number"}},"required":["connectionId"]}}}} ``` ## The WeekDayOfMonthValueDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"WeekDayOfMonthValueDto":{"type":"object","properties":{"firstOrLast":{"type":"string","enum":["first","last"],"description":"First or last weekday of the month."},"weekDay":{"type":"number","enum":[0,1,2,3,4,5,6],"description":"Day of the week."}},"required":["firstOrLast","weekDay"]}}}} ``` ## The RepeatOnValueDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"RepeatOnValueDto":{"type":"object","properties":{"type":{"type":"string","enum":["weekly","monthly"]},"daysOfWeek":{"type":"array","description":"Should be populated when `type` is `weekly`.","items":{"type":"number","enum":[0,1,2,3,4,5,6]}},"dayOfMonth":{"type":"number","description":"Should be populated when `type` is `monthly`. Can be null if `weekDayOfMonth` is populated."},"weekDayOfMonth":{"description":"Should be populated if type of repeat on equal to monthly. Can be null if populated dayOfMonth","allOf":[{"$ref":"#/components/schemas/WeekDayOfMonthValueDto"}]}},"required":["type"]},"WeekDayOfMonthValueDto":{"type":"object","properties":{"firstOrLast":{"type":"string","enum":["first","last"],"description":"First or last weekday of the month."},"weekDay":{"type":"number","enum":[0,1,2,3,4,5,6],"description":"Day of the week."}},"required":["firstOrLast","weekDay"]}}}} ``` ## The SchedulerConfigurationDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"SchedulerConfigurationDto":{"type":"object","properties":{"frequency":{"type":"string","enum":["hourly","daily","weekly","monthly"]},"repeatOn":{"$ref":"#/components/schemas/RepeatOnValueDto"},"repeatEvery":{"type":"number","description":"Repeat every x months/weeks/days/hours."},"runAt":{"type":"string"}},"required":["frequency","repeatEvery","runAt"]},"RepeatOnValueDto":{"type":"object","properties":{"type":{"type":"string","enum":["weekly","monthly"]},"daysOfWeek":{"type":"array","description":"Should be populated when `type` is `weekly`.","items":{"type":"number","enum":[0,1,2,3,4,5,6]}},"dayOfMonth":{"type":"number","description":"Should be populated when `type` is `monthly`. Can be null if `weekDayOfMonth` is populated."},"weekDayOfMonth":{"description":"Should be populated if type of repeat on equal to monthly. Can be null if populated dayOfMonth","allOf":[{"$ref":"#/components/schemas/WeekDayOfMonthValueDto"}]}},"required":["type"]},"WeekDayOfMonthValueDto":{"type":"object","properties":{"firstOrLast":{"type":"string","enum":["first","last"],"description":"First or last weekday of the month."},"weekDay":{"type":"number","enum":[0,1,2,3,4,5,6],"description":"Day of the week."}},"required":["firstOrLast","weekDay"]}}}} ``` ## The CreateBackupSchedulerBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"CreateBackupSchedulerBodyDto":{"type":"object","properties":{"type":{"type":"string","enum":["full backup","templated backup"]},"timezone":{"type":"string","description":"User timezone"},"configuration":{"description":"Information about frequency of scheduler, repeat and running time.","allOf":[{"$ref":"#/components/schemas/SchedulerConfigurationDto"}]},"description":{"type":"string"},"name":{"type":"string","description":"Scheduler name"},"jobSettings":{"description":"Backup job settings. Required if backup type is scheduler.","allOf":[{"$ref":"#/components/schemas/BackupSettingsDto"}]}},"required":["type","timezone","configuration","description","name"]},"SchedulerConfigurationDto":{"type":"object","properties":{"frequency":{"type":"string","enum":["hourly","daily","weekly","monthly"]},"repeatOn":{"$ref":"#/components/schemas/RepeatOnValueDto"},"repeatEvery":{"type":"number","description":"Repeat every x months/weeks/days/hours."},"runAt":{"type":"string"}},"required":["frequency","repeatEvery","runAt"]},"RepeatOnValueDto":{"type":"object","properties":{"type":{"type":"string","enum":["weekly","monthly"]},"daysOfWeek":{"type":"array","description":"Should be populated when `type` is `weekly`.","items":{"type":"number","enum":[0,1,2,3,4,5,6]}},"dayOfMonth":{"type":"number","description":"Should be populated when `type` is `monthly`. Can be null if `weekDayOfMonth` is populated."},"weekDayOfMonth":{"description":"Should be populated if type of repeat on equal to monthly. Can be null if populated dayOfMonth","allOf":[{"$ref":"#/components/schemas/WeekDayOfMonthValueDto"}]}},"required":["type"]},"WeekDayOfMonthValueDto":{"type":"object","properties":{"firstOrLast":{"type":"string","enum":["first","last"],"description":"First or last weekday of the month."},"weekDay":{"type":"number","enum":[0,1,2,3,4,5,6],"description":"Day of the week."}},"required":["firstOrLast","weekDay"]},"BackupSettingsDto":{"type":"object","properties":{"isIncludeMetadata":{"type":"boolean"},"isIncludeBinaryObjects":{"type":"boolean"},"isIncludeBigObjects":{"type":"boolean"},"isIncludeFeedObjects":{"type":"boolean"},"isIncludeShareObjects":{"type":"boolean"},"isIncludeHistoryObjects":{"type":"boolean"},"isIncludeCustomMetadataTypeObjects":{"type":"boolean"},"isIncludeTagObjects":{"type":"boolean"},"templateId":{"type":"number"}},"required":["isIncludeMetadata","isIncludeBinaryObjects","isIncludeBigObjects","isIncludeFeedObjects","isIncludeShareObjects","isIncludeHistoryObjects","isIncludeCustomMetadataTypeObjects","isIncludeTagObjects"]}}}} ``` ## The CreateSchedulerResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"CreateSchedulerResponseDto":{"type":"object","properties":{"id":{"type":"number"}},"required":["id"]}}}} ``` ## The FindAllSchedulersResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FindAllSchedulersResponseDto":{"type":"object","properties":{"type":{"type":"string","enum":["archive","retention policy restore data preparation","full backup","templated backup","full & sync backup","retention policy search","retention policy audit trail","retention policy restore data","retention policy export","retention policy","cache-describe","backup connections metrics"]},"timezone":{"type":"string","description":"User timezone"},"isDefault":{"type":"boolean"},"id":{"type":"number"},"name":{"type":"string"},"configuration":{"$ref":"#/components/schemas/SchedulerConfigurationDto"},"templateName":{"type":"string"},"templateId":{"type":"number"}},"required":["type","timezone","isDefault","id","name","configuration"]},"SchedulerConfigurationDto":{"type":"object","properties":{"frequency":{"type":"string","enum":["hourly","daily","weekly","monthly"]},"repeatOn":{"$ref":"#/components/schemas/RepeatOnValueDto"},"repeatEvery":{"type":"number","description":"Repeat every x months/weeks/days/hours."},"runAt":{"type":"string"}},"required":["frequency","repeatEvery","runAt"]},"RepeatOnValueDto":{"type":"object","properties":{"type":{"type":"string","enum":["weekly","monthly"]},"daysOfWeek":{"type":"array","description":"Should be populated when `type` is `weekly`.","items":{"type":"number","enum":[0,1,2,3,4,5,6]}},"dayOfMonth":{"type":"number","description":"Should be populated when `type` is `monthly`. Can be null if `weekDayOfMonth` is populated."},"weekDayOfMonth":{"description":"Should be populated if type of repeat on equal to monthly. Can be null if populated dayOfMonth","allOf":[{"$ref":"#/components/schemas/WeekDayOfMonthValueDto"}]}},"required":["type"]},"WeekDayOfMonthValueDto":{"type":"object","properties":{"firstOrLast":{"type":"string","enum":["first","last"],"description":"First or last weekday of the month."},"weekDay":{"type":"number","enum":[0,1,2,3,4,5,6],"description":"Day of the week."}},"required":["firstOrLast","weekDay"]}}}} ``` ## The FindSchedulerResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FindSchedulerResponseDto":{"type":"object","properties":{"connectionId":{"type":"number"},"type":{"type":"string","enum":["archive","retention policy restore data preparation","full backup","templated backup","full & sync backup","retention policy search","retention policy audit trail","retention policy restore data","retention policy export","retention policy","cache-describe","backup connections metrics"]},"timezone":{"type":"string","description":"User timezone"},"isDefault":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"number"},"name":{"type":"string"},"templateId":{"type":"number"},"templateName":{"type":"string"},"configuration":{"$ref":"#/components/schemas/SchedulerConfigurationDto"},"jobSettings":{"$ref":"#/components/schemas/BackupSettingsDto"}},"required":["connectionId","type","timezone","isDefault","description","id","name","configuration"]},"SchedulerConfigurationDto":{"type":"object","properties":{"frequency":{"type":"string","enum":["hourly","daily","weekly","monthly"]},"repeatOn":{"$ref":"#/components/schemas/RepeatOnValueDto"},"repeatEvery":{"type":"number","description":"Repeat every x months/weeks/days/hours."},"runAt":{"type":"string"}},"required":["frequency","repeatEvery","runAt"]},"RepeatOnValueDto":{"type":"object","properties":{"type":{"type":"string","enum":["weekly","monthly"]},"daysOfWeek":{"type":"array","description":"Should be populated when `type` is `weekly`.","items":{"type":"number","enum":[0,1,2,3,4,5,6]}},"dayOfMonth":{"type":"number","description":"Should be populated when `type` is `monthly`. Can be null if `weekDayOfMonth` is populated."},"weekDayOfMonth":{"description":"Should be populated if type of repeat on equal to monthly. Can be null if populated dayOfMonth","allOf":[{"$ref":"#/components/schemas/WeekDayOfMonthValueDto"}]}},"required":["type"]},"WeekDayOfMonthValueDto":{"type":"object","properties":{"firstOrLast":{"type":"string","enum":["first","last"],"description":"First or last weekday of the month."},"weekDay":{"type":"number","enum":[0,1,2,3,4,5,6],"description":"Day of the week."}},"required":["firstOrLast","weekDay"]},"BackupSettingsDto":{"type":"object","properties":{"isIncludeMetadata":{"type":"boolean"},"isIncludeBinaryObjects":{"type":"boolean"},"isIncludeBigObjects":{"type":"boolean"},"isIncludeFeedObjects":{"type":"boolean"},"isIncludeShareObjects":{"type":"boolean"},"isIncludeHistoryObjects":{"type":"boolean"},"isIncludeCustomMetadataTypeObjects":{"type":"boolean"},"isIncludeTagObjects":{"type":"boolean"},"templateId":{"type":"number"}},"required":["isIncludeMetadata","isIncludeBinaryObjects","isIncludeBigObjects","isIncludeFeedObjects","isIncludeShareObjects","isIncludeHistoryObjects","isIncludeCustomMetadataTypeObjects","isIncludeTagObjects"]}}}} ``` ## The ProgressStepsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"ProgressStepsResponseDto":{"type":"object","properties":{"objectName":{"type":"string","description":"Object name"},"status":{"type":"string","description":"Status of progress step"},"backupSuccessCount":{"type":"number","description":"Number of successfully backed up records."},"removeSuccessCount":{"type":"number","description":"Number of successfully removed records."},"successCount":{"type":"number","description":"Success count for restore-request/import"},"failedCount":{"type":"number","description":"Failed count for import"},"restoreSuccessCount":{"type":"number","description":"Number of successfully restored records."},"restoreFailedCount":{"type":"number","description":"Number of records that failed to restore."},"updateSuccessCount":{"type":"number","description":"Updated number of successfully restored records."},"updateFailedCount":{"type":"number","description":"Updated number of records that failed to restore."},"searchSuccessCount":{"type":"number","description":"Number of records found in search."}},"required":["objectName","status"]}}}} ``` ## The AbortJobResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"AbortJobResponseDto":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The ApiQuotaDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"ApiQuotaDto":{"type":"object","properties":{"rest":{"type":"number","description":"REST API quota in percentage (1-100)"},"bulk":{"type":"number","description":"Bulk API quota in percentage (1-100)"}},"required":["rest","bulk"]}}}} ``` ## The ConnectionInfoDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"ConnectionInfoDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string","description":"Connection name"},"userName":{"type":"string","description":"Username for authenticating the connection."},"salesforceOrgId":{"type":"string","description":"Salesforce organization ID"},"salesforceOrgType":{"type":"string","enum":["PRODUCTION","SANDBOX"],"description":"Salesforce organization type: SANDBOX or PRODUCTION"}},"required":["id","name","userName","salesforceOrgId","salesforceOrgType"]}}}} ``` ## The SchedulerRunCapabilityDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"SchedulerRunCapabilityDto":{"type":"object","properties":{"isBackupsDisabled":{"type":"boolean"},"isArchivesDisabled":{"type":"boolean"}},"required":["isBackupsDisabled","isArchivesDisabled"]}}}} ``` ## The FindConnectionSettingsResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"FindConnectionSettingsResponseDto":{"type":"object","properties":{"apiQuota":{"$ref":"#/components/schemas/ApiQuotaDto"},"info":{"$ref":"#/components/schemas/ConnectionInfoDto"},"scheduler":{"$ref":"#/components/schemas/SchedulerRunCapabilityDto"},"initialBinaryRecordsLimit":{"type":"number"}},"required":["apiQuota","info","scheduler","initialBinaryRecordsLimit"]},"ApiQuotaDto":{"type":"object","properties":{"rest":{"type":"number","description":"REST API quota in percentage (1-100)"},"bulk":{"type":"number","description":"Bulk API quota in percentage (1-100)"}},"required":["rest","bulk"]},"ConnectionInfoDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string","description":"Connection name"},"userName":{"type":"string","description":"Username for authenticating the connection."},"salesforceOrgId":{"type":"string","description":"Salesforce organization ID"},"salesforceOrgType":{"type":"string","enum":["PRODUCTION","SANDBOX"],"description":"Salesforce organization type: SANDBOX or PRODUCTION"}},"required":["id","name","userName","salesforceOrgId","salesforceOrgType"]},"SchedulerRunCapabilityDto":{"type":"object","properties":{"isBackupsDisabled":{"type":"boolean"},"isArchivesDisabled":{"type":"boolean"}},"required":["isBackupsDisabled","isArchivesDisabled"]}}}} ``` ## The UpdateConnectionBackupSettingBodyDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"UpdateConnectionBackupSettingBodyDto":{"type":"object","properties":{"isBackupsDisabled":{"type":"boolean"},"isArchivesDisabled":{"type":"boolean"},"initialBinaryRecordsLimit":{"type":"number"}},"required":["isBackupsDisabled","isArchivesDisabled","initialBinaryRecordsLimit"]}}}} ``` ## The UpdateApiQuotaResponseDto object ```json {"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.6.12-test.0"},"components":{"schemas":{"UpdateApiQuotaResponseDto":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.flosum.com/api/api-de/sicherungs-and-archiv-api/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.