{"operationsSorter":"alpha","tagsSorter":"alpha","docExpansion":"none","openapi":"3.0.0","info":{"title":"FME Flow REST API V4","description":"FME Flow REST API V4 is our stable REST API.","contact":{"name":"Safe Software Inc.","url":"https://www.safe.com/"},"version":"4"},"tags":[{"name":"broadcast","description":"Broadcast Messages"},{"name":"licensing","description":"Licensing"},{"name":"metrics","description":"Metrics"},{"name":"resources","description":"Resources"},{"name":"streams","description":"Streams"},{"name":"jobs","description":"Jobs"},{"name":"remote engines","description":"Remote Engines"},{"name":"security","description":"Security"},{"name":"engines","description":"Engines"},{"name":"enginemanagement","description":"Engine Management"},{"name":"configuration","description":"Configuration"},{"name":"deployment","description":"Deployment"},{"name":"deployment parameters","description":"Deployment Parameters"},{"name":"migrations","description":"Migration"},{"name":"permissions","description":"Permissions"},{"name":"tokens","description":"Tokens"},{"name":"repositories","description":"Repositories"},{"name":"schedules","description":"Schedules"},{"name":"cleanup","description":"Cleanup"},{"name":"automations","description":"Automations"},{"name":"dependencies","description":"Dependencies"},{"name":"projects","description":"Projects"},{"name":"packages","description":"FME Packages"},{"name":"healthcheck","description":"Health Check"},{"name":"connections","description":"Web & Database Connections"},{"name":"data virtualization","description":"Data Virtualization"},{"name":"notifications","description":"Notifications"},{"name":"authentication services","description":"Authentication Services"}],"paths":{"/workspaces/{repository}/{workspace}/services":{"get":{"tags":["repositories"],"summary":"Retrieve the registered services and service configurations of a workspace","description":"Retrieves a list of FME Flow services and service configurations of a workspace.","operationId":"getServices","parameters":[{"name":"repository","in":"path","description":"The name of the repository containing the proper workspace","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"The name of the workspace to get services from","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Services"}}}}}},"put":{"tags":["repositories"],"summary":"Replace the registered services and service configurations of a workspace","description":"Replaces the set of FME Flow services and service configurations registered to a workspace.","operationId":"updateServices","parameters":[{"name":"repository","in":"path","description":"The name of the repository containing the proper workspace","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"The name of the workspace to replace services for","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"requestBody":{"description":"FME Flow services and service configurations to register the workspace. Any unspecified services will be deregistered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServicesRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/workspaces/{repository}/{workspace}/services/{service}/registered":{"put":{"tags":["repositories"],"summary":"Register or deregister a service to a workspace","description":"Registers or deregisters a service to a workspace","operationId":"updateServiceRegistration","parameters":[{"name":"repository","in":"path","description":"The name of the repository containing the proper workspace.","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"The name of the workspace to update service registration for.","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}},{"name":"service","in":"path","description":"The name of the service to register or deregister.","required":true,"schema":{"type":"string","enum":["fmedatadownload","fmedatastreaming","fmejobsubmitter","fmekmllink"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceRegistrationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/topics/{name}":{"get":{"tags":["notifications"],"summary":"Retrieve a topic","description":"Retrieves a topic.","operationId":"getTopic","parameters":[{"name":"name","in":"path","description":"Name of the topic.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TopicResponse"}}}}}},"put":{"tags":["notifications"],"summary":"Update a topic","description":"Update an existing topic.","operationId":"replaceTopic","parameters":[{"name":"name","in":"path","description":"Name of the topic.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTopicRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["notifications"],"summary":"Delete a topic","description":"Deletes an existing topic.","operationId":"deleteTopic","parameters":[{"name":"name","in":"path","description":"Name of the topic.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/tokens/{id}":{"get":{"tags":["tokens"],"summary":"Retrieve a user token","description":"Retrieve a user token by its unique identifier","operationId":"getToken","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}}}},"put":{"tags":["tokens"],"summary":"Replace a token","description":"Replace a token. Either one of `secondsToExpiry` or `expiration` must be specified, but not both.","operationId":"replaceToken","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTokenRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["tokens"],"summary":"Delete a token","description":"Delete a token given the ID","operationId":"deleteToken","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/tokens/{id}/secondstoexpiry":{"put":{"tags":["tokens"],"summary":"Set expiration timeout for a token","description":"Set the expiration timeout in seconds for the token","operationId":"setSecondsToExpiry","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecondsToExpiryRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/tokens/{id}/items":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for all security items","description":"Retrieves permissions for all security items for the token","operationId":"getAllItemPermissions","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"query","description":"If specified, only items in this category will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionPage"}}}}}},"put":{"tags":["permissions"],"summary":"Update permissions for security items","description":"Updates permissions for security items for the token. Only the items supplied in the request body will be updated, permissions for all other items not supplied in the request body will not be updated. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"replaceItemPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateItemPermissionRequest"}}}},"required":true},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the update operation, indicating success or error status for each item permission update."}}}},"/tokens/{id}/items/{category}/{item}/permissions":{"put":{"tags":["permissions"],"summary":"Update permissions for a security item","description":"Updates permissions for a security item for the user token. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"replaceSingleItemPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security item permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["permissions"],"summary":"Grant permissions for a security item","description":"Grants permissions for a security item for the user token. Existing permissions are not removed. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"grantSingleItemPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security item permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["permissions"],"summary":"Revoke permissions for a security item","description":"Revokes permissions for a security item for the user token.","operationId":"revokeSingleItemPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/tokens/{id}/expiration":{"put":{"tags":["tokens"],"summary":"Set expiration date/time for a token","description":"Set the expiration date/time for the token","operationId":"setExpiration","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpirationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/tokens/{id}/enabled":{"put":{"tags":["tokens"],"summary":"Enable/Disable a token","description":"Set the enabled state for the token","operationId":"enableToken","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokensEnableRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/tokens/{id}/categories":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for all security categories","description":"Retrieves permissions for all security categories for the token","operationId":"getAllCategoryPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryPermissionResponse"}}}}}}},"put":{"tags":["permissions"],"summary":"Update permissions for security categories","description":"Updates permissions for security categories for the token. Only the categories supplied in the request body will be updated, permissions for all other categories not supplied in the request body will not be updated. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"replaceCategoryPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCategoryPermissionRequest"}}}},"required":true},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the update operation, indicating success or error status for each category permissions update."}}}},"/tokens/{id}/categories/{category}/permissions":{"put":{"tags":["permissions"],"summary":"Update permissions for a security category","description":"Updates permissions for a security category for the token. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"replaceSingleCategoryPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["permissions"],"summary":"Grant permissions for a security category","description":"Grants permissions for a security category for the token. Existing permissions are not removed. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"grantSingleCategoryPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["permissions"],"summary":"Revoke permissions for a security category","description":"Revokes permissions for a security category for the token.","operationId":"revokeSingleCategoryPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/systemevents/configurations/{name}":{"get":{"tags":["configuration"],"summary":"Retrieve a system event configuration","description":"Retrieves a system event configuration","operationId":"listSpecificConfiguration","parameters":[{"name":"name","in":"path","description":"Name of the system event configuration","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemEventsConfigurationResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Replace a system event configuration","description":"Replaces a system event configuration","operationId":"updateConfiguration","parameters":[{"name":"name","in":"path","description":"Name of the system event configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemEventsConfigurationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/systemevents/configurations/{name}/enabled":{"put":{"tags":["configuration"],"summary":"Enable/disable system event configurations","description":"Enable or disable a system event configuration","operationId":"updateIsEnabled","parameters":[{"name":"name","in":"path","description":"Name of the system event configuration","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemEventsConfigurationEnabledRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/subscriptions/{subscription}":{"get":{"tags":["notifications"],"summary":"Retrieve a subscription","operationId":"getSubscription","parameters":[{"name":"subscription","in":"path","description":"Name of the subscription to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HttpSubscriptionResponse"},{"$ref":"#/components/schemas/SqsSubscriptionResponse"},{"$ref":"#/components/schemas/LoggerSubscriptionResponse"},{"$ref":"#/components/schemas/FtpSubscriptionResponse"},{"$ref":"#/components/schemas/EventGridSubscriptionResponse"},{"$ref":"#/components/schemas/SnsSubscriptionResponse"},{"$ref":"#/components/schemas/WorkspaceSubscriptionResponse"},{"$ref":"#/components/schemas/DropboxSubscriptionResponse"},{"$ref":"#/components/schemas/JmsSubscriptionResponse"},{"$ref":"#/components/schemas/SftpSubscriptionResponse"},{"$ref":"#/components/schemas/S3SubscriptionResponse"},{"$ref":"#/components/schemas/EmailSubscriptionResponse"},{"$ref":"#/components/schemas/WebSocketSubscriptionResponse"}]}}}}}},"put":{"tags":["notifications"],"summary":"Replace a subscription","operationId":"replaceSubscription","parameters":[{"name":"subscription","in":"path","description":"Name of the subscription to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateDropboxSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateEmailSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateEventGridSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateFtpSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateHttpSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateJmsSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateLoggerSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateS3SubscriptionRequest"},{"$ref":"#/components/schemas/UpdateSftpSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateSnsSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateSqsSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateWebSocketSubscriptionRequest"},{"$ref":"#/components/schemas/UpdateWorkspaceSubscriptionRequest"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["notifications"],"summary":"Delete a subscription","operationId":"deleteSubscription","parameters":[{"name":"subscription","in":"path","description":"Name of the subscription to remove","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/streams/{id}":{"get":{"tags":["streams"],"summary":"Retrieve an individual stream","description":"Retrieves an individual stream by its unique identifier.","operationId":"get","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"includeEngineInfo","in":"query","description":"Whether to include information about engines assigned to the stream","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamResponse"}}}}}},"put":{"tags":["streams"],"summary":"Replace a stream","description":"Replace a stream given the information in the request body","operationId":"replaceStream","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStreamRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["streams"],"summary":"Delete a stream","description":"Delete a stream given the ID","operationId":"delete","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/streams/{id}/enginerules":{"get":{"tags":["streams"],"summary":"Retrieve specific engine assignment rule","description":"Retrieves specific engine assignment rule.","operationId":"get_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamEngineRuleResponse"}}}}}},"put":{"tags":["streams"],"summary":"Updates an engine assignment rule","description":"Updates an existing engine assignment rule.","operationId":"update","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStreamEngineRuleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["streams"],"summary":"Create an engine assignment rule","description":"Creates an engine assignment rule.","operationId":"create_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewStreamEngineRuleRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}},"delete":{"tags":["streams"],"summary":"Delete an engine assignment rule","description":"Deletes an existing engine assignment rule.","operationId":"delete_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/streams/{id}/enabled":{"put":{"tags":["streams"],"summary":"Enable/Disable a stream","description":"Enable/Disable a stream given the information in the request body","operationId":"enableStream","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamsEnableRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/schedules/{id}":{"get":{"tags":["schedules"],"summary":"Retrieve a schedule","description":"Retrieve a schedule by its unique identifier","operationId":"getSchedule","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the schedule","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResponse"}}}}}},"put":{"tags":["schedules"],"summary":"Replace a schedule","description":"Replace a schedule given the ID","operationId":"replaceSchedule","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the schedule","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScheduleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["schedules"],"summary":"Delete a schedule","description":"Delete a schedule given the ID","operationId":"deleteSchedule","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the schedule","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/schedules/{id}/enabled":{"put":{"tags":["schedules"],"summary":"Enable/Disable a schedule","description":"Set the enabled state for the schedule","operationId":"enableSchedule","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the schedule","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleEnableRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/schedules/tags/{tagID}":{"get":{"tags":["schedules"],"summary":"Retrieve a schedule tag","operationId":"get_2","parameters":[{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TagResponse"}}}}}},"put":{"tags":["schedules"],"summary":"Update a schedule tag","operationId":"update_1","parameters":[{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["schedules"],"summary":"Delete a schedule tag","operationId":"delete_2","parameters":[{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/saml/{id}":{"get":{"tags":["authentication services"],"summary":"Retrieve specific SAML configuration","operationId":"getSAMLConfig","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLConfigResponse"}}}}}},"put":{"tags":["authentication services"],"summary":"Updates a SAML configuration","operationId":"updateSAMLConfig","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSAMLConfigRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Delete a SAML configuration","operationId":"deleteSAMLConfig","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/saml/{id}/enabled":{"put":{"tags":["authentication services"],"summary":"Enable/Disable a SAML configuration","operationId":"enableSAMLConfig","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLConfigurationEnableRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/roles/{id}":{"get":{"tags":["security"],"summary":"Retrieve a user role","description":"Retrieves a user role","operationId":"getRole","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ldap","in":"query","description":"If specified, retrieve LDAP information for the user role. This requires a connection to the LDAP Server.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/RoleResponse"},{"$ref":"#/components/schemas/RoleWithLdapInfoResponse"}]}}}}}},"put":{"tags":["security"],"summary":"Replace a role","description":"Replaces a role.","operationId":"replaceRole","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["security"],"summary":"Delete a role","description":"Delete a role","operationId":"deleteRole","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/roles/{id}/items":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for all security items","description":"Retrieves permissions for all security items for the role","operationId":"getAllItemPermissions_1","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"query","description":"If specified, only items in this category will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionPage"}}}}}},"put":{"tags":["permissions"],"summary":"Update permissions for security items","description":"Updates permissions for security items for the role. Only the items supplied in the request body will be updated, permissions for all other items not supplied in the request body will not be updated. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"replaceItemPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateItemPermissionRequest"}}}},"required":true},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the update operation, indicating success or error status for each item permission update."}}}},"/roles/{id}/items/{category}/{item}/permissions":{"put":{"tags":["permissions"],"summary":"Update permissions for a security item","description":"Updates permissions for a security item for the role. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"replaceSingleItemPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security item permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["permissions"],"summary":"Grant permissions for a security item","description":"Grants permissions for a security item for the role. Existing permissions are not removed. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"grantSingleItemPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security item permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["permissions"],"summary":"Revoke permissions for a security item","description":"Revokes permissions for a security item for the role.","operationId":"revokeSingleItemPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/roles/{id}/categories":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for all security categories","description":"Retrieves permissions for all security categories for the role","operationId":"getAllCategoryPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryPermissionResponse"}}}}}}},"put":{"tags":["permissions"],"summary":"Update permissions for security categories","description":"Updates permissions for security categories for the role. Only the categories supplied in the request body will be updated, permissions for all other categories not supplied in the request body will not be updated. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"replaceCategoryPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCategoryPermissionRequest"}}}},"required":true},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the update operation, indicating success or error status for each category permissions update."}}}},"/roles/{id}/categories/{category}/permissions":{"put":{"tags":["permissions"],"summary":"Update permissions for a security category","description":"Updates/replaces permissions for a security category for the role. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"replaceSingleCategoryPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["permissions"],"summary":"Grant permissions for a security category","description":"Grants permissions for a security category for the role. Existing permissions are not removed. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"grantSingleCategoryPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["permissions"],"summary":"Revoke permissions for a security category","description":"Revokes permissions for a security category for the role.","operationId":"revokeSingleCategoryPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/roles/{id}/accounts":{"get":{"tags":["security"],"summary":"Get user accounts","description":"Get the user accounts of a role","operationId":"getRoles_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RoleAccountAssignmentResponse"}}}}}}},"put":{"tags":["security"],"summary":"Replace the accounts assigned to a role","description":"Replaces all of the accounts that are assigned to a role.","operationId":"replaceAccounts","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Accounts to assign to the role","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["security"],"summary":"Assign accounts to a role","description":"Assigns accounts to a role.","operationId":"assignAccounts","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Accounts to assign to the role","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/resources/connections/{connection}":{"get":{"tags":["resources"],"summary":"Retrieve resource connection details","description":"Retrieves information about a resource connection.","operationId":"getConnection","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SharedResourceResponse"}}}}}},"put":{"tags":["resources"],"summary":"Replace a resource connection","description":"Replace an existing resource connection. Use method GET /resources/types to retrieve the valid types of resources and valid properties for each type. Replacing file resource is not supported. If a password or secret key is not supplied, then the password or secret key for this resource connection will not be updated.","operationId":"replaceConnection","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSharedResourceRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["resources"],"summary":"Delete a resource connection","description":"Deletes an existing resource connection.","operationId":"deleteConnection","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/repositories/{repository}":{"get":{"tags":["repositories"],"summary":"Retrieve a repository","description":"Retrieves a repository","operationId":"getRepository","parameters":[{"name":"repository","in":"path","description":"Specifies the name of the repository","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RepositoryResponse"}}}}}},"put":{"tags":["repositories"],"summary":"Replace a repository","description":"Replaces a repository.","operationId":"replaceRepository","parameters":[{"name":"repository","in":"path","description":"Specifies the name of the repository","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRepositoryRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["repositories"],"summary":"Delete a repository","description":"Delete a repository","operationId":"deleteRepository","parameters":[{"name":"repository","in":"path","description":"Specifies the name of the repository","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/remoteengines/{id}":{"get":{"tags":["remote engines"],"summary":"Retrieve a Remote Engine connection","description":"Retrieves a Remote Engine connection","operationId":"getConnection_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/RemoteEngineConnectionResponse"},{"$ref":"#/components/schemas/RemoteEngineConnectionResponseSnowflake"}]}}}}}},"put":{"tags":["remote engines"],"summary":"Replace a Remote Engine connection","description":"Replaces a Remote Engine connection","operationId":"replaceConnection_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateRemoteEngineConnectionRequest"},{"$ref":"#/components/schemas/UpdateRemoteEngineConnectionRequestSnowflake"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["remote engines"],"summary":"Delete a Remote Engine connection","description":"Delete a Remote Engine connection","operationId":"deleteConnection_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/remoteengines/{id}/accounts/{account}/password":{"put":{"tags":["remote engines"],"summary":"Update an account password on a Remote Engine Service using the details of an existing connection","description":"Updates an account password on a Remote Engine Service using the details of an existing connection. Any properties supplied in the request will override existing properties.","operationId":"updatePasswordExisting","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"account","in":"path","description":"Specifies the user account name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdatePasswordExistingRemoteEngineConnectionRequest"},{"$ref":"#/components/schemas/UpdatePasswordExistingRemoteEngineConnectionRequestSnowflake"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/remoteengines/accounts/{account}/password":{"put":{"tags":["remote engines"],"summary":"Update an account password on a Remote Engine Service","operationId":"updatePassword","parameters":[{"name":"account","in":"path","description":"Specifies the user account name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdatePasswordRequest"},{"$ref":"#/components/schemas/UpdatePasswordRequestSnowflake"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/queues/{name}":{"get":{"tags":["enginemanagement"],"summary":"Retrieve a queue","description":"Retrieves a queue","operationId":"getQueue","parameters":[{"name":"name","in":"path","description":"Name of the queue","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DetailedQueueResponse"}}}}}},"put":{"tags":["enginemanagement"],"summary":"Replace a queue","description":"Replaces a queue.","operationId":"replaceQueue","parameters":[{"name":"name","in":"path","description":"Name of the queue","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQueueRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["enginemanagement"],"summary":"Delete a queue","description":"Delete a queue","operationId":"deleteQueue","parameters":[{"name":"name","in":"path","description":"Name of the queue","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/publications/{publication}":{"get":{"tags":["notifications"],"summary":"Retrieve a publication","operationId":"getPublication","parameters":[{"name":"publication","in":"path","description":"Name of the publication to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SqsPublicationResponse"},{"$ref":"#/components/schemas/DropboxWatchPublicationResponse"},{"$ref":"#/components/schemas/DirWatchPublicationResponse"},{"$ref":"#/components/schemas/EventGridPublicationResponse"},{"$ref":"#/components/schemas/SnsPublicationResponse"},{"$ref":"#/components/schemas/S3WatchPublicationResponse"},{"$ref":"#/components/schemas/FtpWatchPublicationResponse"},{"$ref":"#/components/schemas/JmsPublicationResponse"},{"$ref":"#/components/schemas/SmtpPublicationResponse"},{"$ref":"#/components/schemas/WebSocketPublicationResponse"},{"$ref":"#/components/schemas/UdpPublicationResponse"},{"$ref":"#/components/schemas/ImapPublicationResponse"}]}}}}}},"put":{"tags":["notifications"],"summary":"Replace a publication","operationId":"replacePublication","parameters":[{"name":"publication","in":"path","description":"Name of the publication to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateDirWatchPublicationRequest"},{"$ref":"#/components/schemas/UpdateDropboxWatchPublicationRequest"},{"$ref":"#/components/schemas/UpdateEventGridPublicationRequest"},{"$ref":"#/components/schemas/UpdateFtpWatchPublicationRequest"},{"$ref":"#/components/schemas/UpdateImapPublicationRequest"},{"$ref":"#/components/schemas/UpdateJmsPublicationRequest"},{"$ref":"#/components/schemas/UpdateS3WatchPublicationRequest"},{"$ref":"#/components/schemas/UpdateSmtpPublicationRequest"},{"$ref":"#/components/schemas/UpdateSnsPublicationRequest"},{"$ref":"#/components/schemas/UpdateSqsPublicationRequest"},{"$ref":"#/components/schemas/UpdateUdpPublicationRequest"},{"$ref":"#/components/schemas/UpdateWebSocketPublicationRequest"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["notifications"],"summary":"Delete a publication","operationId":"deletePublication","parameters":[{"name":"publication","in":"path","description":"Name of the publication to remove","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/projects/{id}":{"get":{"tags":["projects"],"summary":"Retrieve a project","description":"Retrieves a project","operationId":"getProject","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}}}},"put":{"tags":["projects"],"summary":"Update an existing project","description":"Updates the fields specified in the request body of an existing project","operationId":"update_2","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}},"delete":{"tags":["projects"],"summary":"Delete a project","description":"Delete a project given the ID","operationId":"deleteProject","parameters":[{"name":"id","in":"path","description":"UUID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/projects/{id}/icon":{"get":{"tags":["projects"],"summary":"Retrieve a project icon","description":"Retrieves a project's icon","operationId":"getIcon","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success. The icon blob is in the response body.","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}}}},"put":{"tags":["projects"],"summary":"Update the project icon","description":"Updates a project's icon","operationId":"updateIcon","parameters":[{"name":"id","in":"path","description":"UUID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The project icon file","format":"binary"}}}}}},"responses":{"200":{"description":"OK"},"204":{"description":"No Content"}}},"delete":{"tags":["projects"],"summary":"Delete a project icon","description":"Delete a project's icon given the project's ID","operationId":"deleteIcon","parameters":[{"name":"id","in":"path","description":"UUID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content. If it existed, the project icon was deleted."}}}},"/projects/imports/{id}":{"get":{"tags":["projects"],"summary":"Get an import","description":"Get the information about an import, whether created by uploading or from a shared resource","operationId":"get_4","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImportResponse"}}}}}},"put":{"tags":["projects"],"summary":"Updates an import","description":"Updates an existing import's settings as specified in the request body","operationId":"updateImportSettings","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSettingsRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["projects"],"summary":"Deletes an import","description":"Deletes an existing import, and deletes the associated uploaded file if present","operationId":"delete_3","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"}}}},"/permissions/items/{category}/{item}":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for security item","description":"Retrieves permissions for a security item","operationId":"getItem","parameters":[{"name":"category","in":"path","description":"Category of the security item","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the security item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionsResponse"}}}}}},"put":{"tags":["permissions"],"summary":"Update a security item","description":"Updates a security item.","operationId":"updateItem","parameters":[{"name":"category","in":"path","description":"Category of the security item","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the security item","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateItemPermissionsRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/permissions/items/{category}/{item}/ownerid":{"put":{"tags":["permissions"],"summary":"Update the owner of a security item","description":"Updates the owner of a security item.","operationId":"updateItemOwner","parameters":[{"name":"category","in":"path","description":"Category of the security item","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the security item","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateItemOwnerRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/ldap/windows/{id}":{"get":{"tags":["authentication services"],"summary":"Retrieve Windows LDAP server details","operationId":"getWindowsServer","parameters":[{"name":"id","in":"path","description":"ID of the Windows LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WindowsLdapServerResponse"}}}}}},"put":{"tags":["authentication services"],"summary":"Update a Windows LDAP server","description":"Updates a Windows LDAP server. The settings provided will replace the settings in the existing LDAP server. Note: all fields will be replaced. If a field is not provided, then a default value will be used.","operationId":"updateWindowsServer","parameters":[{"name":"id","in":"path","description":"ID of the Windows LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWindowsLdapServerRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Delete a Windows LDAP server","operationId":"deleteWindowsServer","parameters":[{"name":"id","in":"path","description":"ID of the Windows LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/ldap/generic/{id}":{"get":{"tags":["authentication services"],"summary":"Retrieve generic LDAP server details","operationId":"getGenericServer","parameters":[{"name":"id","in":"path","description":"ID of the generic LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericLdapServerResponse"}}}}}},"put":{"tags":["authentication services"],"summary":"Update a generic LDAP server","description":"Updates a generic LDAP server. The settings provided will replace the settings in the existing LDAP server. Note: all fields will be replaced. If a field is not provided, then a default value will be used.","operationId":"updateGenericServer","parameters":[{"name":"id","in":"path","description":"ID of the generic LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGenericLdapServerRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Delete a generic LDAP server","operationId":"deleteGenericServer","parameters":[{"name":"id","in":"path","description":"ID of the generic LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/jobrules/{id}":{"get":{"tags":["enginemanagement"],"summary":"Retrieve specific job routing rule","description":"Retrieves specific job routing rule.","operationId":"getJobRule","parameters":[{"name":"id","in":"path","description":"ID of the job routing rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobRuleResponse"}}}}}},"put":{"tags":["enginemanagement"],"summary":"Updates a job routing rule","description":"Updates an existing job routing rule.","operationId":"updateJobRule","parameters":[{"name":"id","in":"path","description":"ID of the job routing rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateJobRuleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["enginemanagement"],"summary":"Delete a job routing rule","description":"Deletes an existing job routing rule.","operationId":"deleteJobRoute","parameters":[{"name":"id","in":"path","description":"ID of the job routing rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/jobrules/{id}/enabled":{"put":{"tags":["enginemanagement"],"summary":"Enable/Disable a job routing rule","description":"Enable/Disable a job routing rule.","operationId":"enableJobRoute","parameters":[{"name":"id","in":"path","description":"ID of the job routing rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableJobRuleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/jobrules/order":{"put":{"tags":["enginemanagement"],"summary":"Update job routing rule order by swapping order","description":"Updates an existing job routing rule order by swapping order.","operationId":"orderJobRoute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderJobRuleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/entraid/{id}":{"get":{"tags":["authentication services"],"summary":"Retrieve a Microsoft Entra (Azure AD) connection details","operationId":"getConnection_2","parameters":[{"name":"id","in":"path","description":"The id of the Microsoft Entra (Azure AD) connection to return.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EntraIDPrimaryTenantResponse"},{"$ref":"#/components/schemas/EntraIDSecondaryTenantResponse"}]}}}}}},"put":{"tags":["authentication services"],"summary":"Update a Microsoft Entra (Azure AD) connection","operationId":"replaceConnection_2","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateEntraIDPrimaryTenantRequest"},{"$ref":"#/components/schemas/UpdateEntraIDSecondaryTenantRequest"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Remove a Microsoft Entra (Azure AD) connection","operationId":"deleteConnection_2","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/enginerules/{id}":{"get":{"tags":["enginemanagement"],"summary":"Retrieve specific engine assignment rule","description":"Retrieves specific engine assignment rule.","operationId":"getEngineRule","parameters":[{"name":"id","in":"path","description":"ID of the engine rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EngineRuleResponse"}}}}}},"put":{"tags":["enginemanagement"],"summary":"Updates an engine assignment rule","description":"Updates an existing engine assignment rule.","operationId":"updateEngineRule","parameters":[{"name":"id","in":"path","description":"ID of the engine assignment rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEngineRuleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["enginemanagement"],"summary":"Delete an engine assignment rule","description":"Deletes an existing engine assignment rule.","operationId":"deleteEngineRule","parameters":[{"name":"id","in":"path","description":"ID of the engine assignment rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/enginerules/{id}/enabled":{"put":{"tags":["enginemanagement"],"summary":"Enable/Disable an engine assignment rule","description":"Enable/Disable an engine assignment rule.","operationId":"enableEngineRule","parameters":[{"name":"id","in":"path","description":"ID of the engine assignment rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableEngineRuleRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/deploymentparameters/{name}":{"get":{"tags":["deployment parameters"],"summary":"Retrieve an individual deployment parameter","description":"Retrieves an individual deployment parameter by its unique name","operationId":"get_8","parameters":[{"name":"name","in":"path","description":"Name of the deployment parameter.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DeploymentParameterResponse"},{"$ref":"#/components/schemas/DeploymentParameterDropdownResponse"},{"$ref":"#/components/schemas/DeploymentParameterPasswordResponse"},{"$ref":"#/components/schemas/DeploymentParameterTextResponse"}]}}}}}},"put":{"tags":["deployment parameters"],"summary":"Update an existing deployment parameter","description":"Updates the value and type of a deployment parameter.    Deployment parameters support a subset of the FME JSON Parameters specification.   Here are examples of JSON requests to define the types that are currently supported.\n\n   **Text**\n   ```\n   {\n     \"value\": \"Example\",\n     \"type\": \"text\"\n   }\n   ```\n\n   **Database Connection**\n   ```\n   {\n     \"value\": \"Example\",\n     \"type\": \"dropdown\",\n     \"choiceSettings\": {\n       \"choiceSet\": \"dbConnections\",\n       \"family\": \"Example\"\n     }\n   }\n   ```\n\n   **Web Connection**\n   ```\n   {\n     \"value\": \"Example\",\n     \"type\": \"dropdown\",\n     \"choiceSettings\": {\n       \"choiceSet\": \"webConnections\",\n       \"services\": [\n         \"Example\"\n       ],\n       \"excludedServices\": [\n         \"Example\"\n       ]\n     }\n   }\n   ```\n\n   **Password**\n   ```\n   {\n     \"value\": \"Example\",\n     \"type\": \"password\"\n   }\n   ```\n","operationId":"updateDeploymentParameter","parameters":[{"name":"name","in":"path","description":"Name of the deployment parameter.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DeploymentParameterRequest"},{"$ref":"#/components/schemas/DeploymentParameterDropdown"},{"$ref":"#/components/schemas/DeploymentParameterPassword"},{"$ref":"#/components/schemas/DeploymentParameterText"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["deployment parameters"],"summary":"Delete a deployment parameter.","description":"Delete a deployment parameter given the name.","operationId":"delete_5","parameters":[{"name":"name","in":"path","description":"Name of the deployment parameter.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}":{"get":{"tags":["data virtualization"],"summary":"Retrieve a data virtualization API","operationId":"get_10","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataVirtualizationApiResponse"}}}}}},"put":{"tags":["data virtualization"],"summary":"Update a data virtualization API","operationId":"update_3","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDataVirtualizationApiRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["data virtualization"],"summary":"Delete a data virtualization API","operationId":"delete_6","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/tags/{tagID}":{"get":{"tags":["data virtualization"],"summary":"Retrieve a tag for a data virtualization API","operationId":"get_11","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataVirtualizationTagResponse"}}}}}},"put":{"tags":["data virtualization"],"summary":"Updates a tag for a data virtualization API","operationId":"update_4","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationTagRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["data virtualization"],"summary":"Delete a tag for a data virtualization API","operationId":"delete_7","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/security":{"put":{"tags":["data virtualization"],"summary":"Update the security configuration for a data virtualization API","operationId":"updateSecurity","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationApiSecurityRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/jobexpiry":{"put":{"tags":["data virtualization"],"summary":"Update the job expiry configuration for a data virtualization API","operationId":"updateJobExpiry","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationApiJobExpiryRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/endpoints/{endpointID}/security":{"put":{"tags":["data virtualization"],"summary":"Updates the security configuration for a data virtualization API endpoint","operationId":"updateSecurity_1","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"endpointID","in":"path","description":"Specifies the UUID (unique identifier) of the endpoint","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationEndpointSecurityRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/endpoints/{endpointID}/jobexpiry":{"put":{"tags":["data virtualization"],"summary":"Updates the job expiry configuration for a data virtualization API endpoint","operationId":"updateJobExpiry_1","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"endpointID","in":"path","description":"Specifies the UUID (unique identifier) of the endpoint","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationEndpointJobExpiryRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/endpoints/{endpointID}/caching":{"put":{"tags":["data virtualization"],"summary":"Updates the caching configuration for a data virtualization API endpoint","operationId":"updateCaching","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"endpointID","in":"path","description":"Specifies the UUID (unique identifier) of the endpoint","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationEndpointCachingRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/endpoints/{endpointID}/asyncprocessing":{"put":{"tags":["data virtualization"],"summary":"Updates the asynchronous processing configuration for a data virtualization API endpoint","operationId":"updateAsyncProcessing","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"endpointID","in":"path","description":"Specifies the UUID (unique identifier) of the endpoint","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationEndpointAsyncRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/endpoints/responsetype":{"put":{"tags":["data virtualization"],"summary":"Update the response type for a list of endpoints","operationId":"updateResponseType","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationEndpointUpdateResponseType"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/caching":{"put":{"tags":["data virtualization"],"summary":"Update the caching configuration for a data virtualization API","operationId":"updateCaching_1","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationApiCachingRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/asyncprocessing":{"put":{"tags":["data virtualization"],"summary":"Update the asynchronous processing configuration for a data virtualization API","operationId":"updateAsyncProcessing_1","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationApiAsyncRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/connections/{connection}":{"get":{"tags":["connections"],"summary":"Retrieve a connection","operationId":"getConnection_3","parameters":[{"name":"connection","in":"path","description":"Specifies the name of the connection","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DatabaseConnectionResponse"},{"$ref":"#/components/schemas/TokenConnectionResponse"},{"$ref":"#/components/schemas/BasicConnectionResponse"},{"$ref":"#/components/schemas/OAuthV2ConnectionResponse"}]}}}}}},"put":{"tags":["connections"],"summary":"Replace the connection details for an existing connection","description":"Replaces the various connection-related details for an existing connection, but does not replace the connection itself","operationId":"replaceConnectionDetails","parameters":[{"name":"connection","in":"path","description":"Specifies the name of the connection whose details should be replaced","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateBasicConnectionRequest"},{"$ref":"#/components/schemas/UpdateDatabaseConnectionRequest"},{"$ref":"#/components/schemas/UpdateOAuthV2ConnectionRequest"},{"$ref":"#/components/schemas/UpdateTokenConnectionRequest"}]}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["connections"],"summary":"Delete a connection","operationId":"deleteConnection_3","parameters":[{"name":"connection","in":"path","description":"Specifies the name of the connection to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/configuration/topicmonitoring/internalWebsocketUrl":{"put":{"tags":["configuration"],"summary":"Update the internal websocket URL configuration.","operationId":"updateInternalWebSocketURLConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicMonitoringURLRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/topicmonitoring/externalWebsocketPort":{"put":{"tags":["configuration"],"summary":"Update the external websocket port configuration.","operationId":"updateIExternalWebSocketPortConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicMonitoringPortRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/topicmonitoring/externalWebsocketHost":{"put":{"tags":["configuration"],"summary":"Update the external websocket host configuration.","operationId":"updateExternalWebSocketHostConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopicMonitoringHostRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/systememail":{"get":{"tags":["configuration"],"summary":"Retrieve system email properties","description":"Retrieves system email properties.","operationId":"getSystemEmailProps","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SystemEmailPropsResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Update system email properties","description":"Updates system email properties.","operationId":"updateSystemEmailProps","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSystemEmailPropsRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/proxy":{"get":{"tags":["configuration"],"summary":"Retrieve the proxy configuration","operationId":"getProxyConfig","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProxyConfigResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Update the proxy configuration","operationId":"updateProxyConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProxyConfigRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordreuse":{"get":{"tags":["configuration"],"summary":"Retrieve the password reuse configuration","description":"Retrieves the password reuse configuration.","operationId":"getPasswordReuseCheck","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PasswordReuseCheckResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Update the password reuse configuration","description":"Enables or disables password reuse check and specifies the number of recent passwords to check for reuse.","operationId":"updatePasswordReuseCheck","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePasswordReuseCheckRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordreuse/enabled":{"put":{"tags":["configuration"],"summary":"Enable or disable password reuse check","description":"Enables or disables password reuse check.","operationId":"enablePasswordReuseCheck","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnablePasswordReuseCheckRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordreset":{"get":{"tags":["configuration"],"summary":"Retrieve information about password reset configuration","description":"Retrieves the reset password configuration","operationId":"getPasswordResetProperties","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PasswordResetPropertiesResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Update password reset configuration","description":"Update password reset configuration","operationId":"setPasswordResetProperties","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordResetPropertiesRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordreset/enabled":{"get":{"tags":["configuration"],"summary":"Retrieve enabled status for password reset","description":"Retrieves the reset password enabled status","operationId":"getIsEnabled","responses":{"200":{"description":"The configured settings for password reset are rendered in the response body.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnablePasswordResetResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Enable/Disable password reset","description":"Enable or Disable password reset","operationId":"setIsEnabled","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnablePasswordResetRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordpolicy":{"get":{"tags":["configuration"],"summary":"Retrieve a password policy","description":"Retrieves a password policy","operationId":"getPasswordPolicy","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PasswordPolicyResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Update a password policy","operationId":"updatePasswordPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePasswordPolicyRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordpolicy/enabled":{"put":{"tags":["configuration"],"summary":"Enable or disable a password policy","operationId":"enablePasswordPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnablePasswordPolicyRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordexpiration":{"get":{"tags":["configuration"],"summary":"Retrieve the current password expiration configuration","operationId":"getPasswordExpiration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PasswordExpirationResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Update a password expiration configuration","description":"Enables or disables password expiration and specifies the number of days after which a password expires.","operationId":"updatePasswordExpiration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePasswordExpirationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/passwordexpiration/enabled":{"put":{"tags":["configuration"],"summary":"Enable or disable password expiration","operationId":"enablePasswordExpiration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnablePasswordExpirationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/multiplewebsessions":{"get":{"tags":["configuration"],"summary":"Retrieve the configuration for allowing multiple web sessions.","operationId":"getMultiWebSessionsConfig","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MultiWebSessionsResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Update the configuration to allowing multiple web sessions.","description":"When enabled, a user can login to FME Flow with more than one browser at a time.","operationId":"updateMultiWebSessionsConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiWebSessionsRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/engines":{"get":{"tags":["configuration"],"summary":"Retrieves global configuration for engines","operationId":"getEnginesConfig","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnginesConfigResponse"}}}}}},"put":{"tags":["configuration"],"summary":"Updates global configuration for engines","operationId":"updateEnginesConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEnginesConfigRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/configuration/encryption/mode/weak":{"put":{"tags":["configuration"],"summary":"Reset FME Server encryption to default (weak) mode","description":"Reset FME Server encryption to weak mode. This will delete the encryption key file.","operationId":"reset","responses":{"204":{"description":"No Content"}}}},"/configuration/encryption/keyfile":{"get":{"tags":["configuration"],"summary":"Download the encryption key file","operationId":"downloadKey","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"tags":["configuration"],"summary":"Upload an encryption key file.","operationId":"uploadKeyFile","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The encryption key file.","format":"binary"}}}}}},"responses":{"204":{"description":"No Content"}}}},"/cleanup/tasks/{category}/{name}":{"get":{"tags":["cleanup"],"summary":"Retrieve an individual cleanup task","operationId":"getTask","parameters":[{"name":"category","in":"path","description":"Category of the cleanup task","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Name of the cleanup task","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CleanupTaskResponse"}}}}}},"put":{"tags":["cleanup"],"summary":"Update a cleanup task","description":"Updates information for an existing cleanup task given a category and name","operationId":"replaceTask","parameters":[{"name":"name","in":"path","description":"Specifies the name of the cleanup task","required":true,"schema":{"type":"string"}},{"name":"category","in":"path","description":"Specifies the category of the cleanup task","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCleanupTaskRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["cleanup"],"summary":"Delete a cleanup task","operationId":"deleteTask","parameters":[{"name":"name","in":"path","description":"Specifies the name of the cleanup task","required":true,"schema":{"type":"string"}},{"name":"category","in":"path","description":"Specifies the category of the cleanup task","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/cleanup/tasks/{category}/{name}/enabled":{"put":{"tags":["cleanup"],"summary":"Enable/Disable a cleanup task","operationId":"enableTask","parameters":[{"name":"name","in":"path","description":"Specifies the name of the cleanup task","required":true,"schema":{"type":"string"}},{"name":"category","in":"path","description":"Specifies the category of the cleanup task","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CleanupTaskEnableRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/cleanup/system/{type}":{"get":{"tags":["cleanup"],"summary":"Retrieve an individual system scheduled cleanup task","operationId":"getTask_1","parameters":[{"name":"type","in":"path","description":"The particular system task to get","required":true,"schema":{"type":"string","enum":["jobs","systemEvents","tokens","automationLogs"]}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CleanupSystemTaskResponse"}}}}}},"put":{"tags":["cleanup"],"summary":"Update a system scheduled cleanup task","operationId":"replaceTask_1","parameters":[{"name":"type","in":"path","description":"The particular system task to modify","required":true,"schema":{"type":"string","enum":["jobs","systemEvents","tokens","automationLogs"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSystemTaskRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/cleanup/configuration":{"get":{"tags":["cleanup"],"summary":"Retrieves the configuration settings for FME Flow cleanup","description":"Retrieves the configuration settings for FME Flow cleanup. A warning level event will trigger all cleanup tasks to execute as they are configured. A critical level event will trigger all cleanup tasks to execute and disregard max age constraints. This means resources are purged regardless of how old they are.","operationId":"getConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CleanupConfigurationResponse"}}}}}},"put":{"tags":["cleanup"],"summary":"Updates the configuration settings for FME Flow cleanup","description":"Updates the configuration settings for FME Flow cleanup. A warning level event will trigger all cleanup tasks to execute as they are configured. A critical level event will trigger all cleanup tasks to execute and disregard max age constraints. This means resources are purged regardless of how old they are.","operationId":"replaceConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CleanupConfigurationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/broadcast/messages/{id}":{"get":{"tags":["broadcast"],"summary":"Retrieve broadcast message","description":"Retrieves a broadcast message.","operationId":"getMessage","parameters":[{"name":"id","in":"path","description":"ID of the broadcast message.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BroadcastMessageResponse"}}}}}},"put":{"tags":["broadcast"],"summary":"Update a broadcast message","description":"Update an existing broadcast message.","operationId":"replaceMessage","parameters":[{"name":"id","in":"path","description":"ID of the broadcast message.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBroadcastMessageRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["broadcast"],"summary":"Delete a broadcast message","description":"Deletes an existing broadcast message.","operationId":"deleteMessage","parameters":[{"name":"id","in":"path","description":"ID of the broadcast message.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/automations/{id}":{"get":{"tags":["automations"],"summary":"Retrieve an automation workflow","description":"Retrieves an automation workflow by its unique identifier","operationId":"getAutomation","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the automation workflow","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AutomationResponse"}}}}}},"put":{"tags":["automations"],"summary":"Replace an automation workflow","description":"Replaces an automation workflow.","operationId":"updateAutomation","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the automation workflow","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAutomationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["automations"],"summary":"Delete an automation workflow","description":"Deletes an automation workflow.","operationId":"deleteAutomation","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the automation workflow","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/automations/{id}/enabled":{"put":{"tags":["automations"],"summary":"Enable/Disable an automation workflow","description":"Set the enabled state for the automation workflow","operationId":"enableAutomation","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the automation workflow","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationEnableRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/automations/tags/{tagID}":{"get":{"tags":["automations"],"summary":"Retrieve an automation tag","operationId":"get_12","parameters":[{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TagResponse"}}}}}},"put":{"tags":["automations"],"summary":"Update an automation tag","operationId":"update_5","parameters":[{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["automations"],"summary":"Delete an automation tag","operationId":"delete_9","parameters":[{"name":"tagID","in":"path","description":"Specifies the UUID (unique identifier) of the tag","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/activeperiods/{id}":{"get":{"tags":["enginemanagement"],"summary":"Retrieve specific active period","description":"Retrieves specific active period.","operationId":"getActivePeriod","parameters":[{"name":"id","in":"path","description":"ID of the active period.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivePeriodResponse"}}}}}},"put":{"tags":["enginemanagement"],"summary":"Updates an active period","description":"Updates an active period.","operationId":"updateActivePeriod","parameters":[{"name":"id","in":"path","description":"ID of the active period.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivePeriodRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["enginemanagement"],"summary":"Delete an active period","description":"Deletes an existing active period.","operationId":"deleteActivePeriod","parameters":[{"name":"id","in":"path","description":"ID of the active period.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}":{"get":{"tags":["security"],"summary":"Retrieve a user account","description":"Retrieves a user account by its unique identifier","operationId":"getAccount","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ldap","in":"query","description":"If specified, retrieve LDAP information for the user account. This requires a connection to the LDAP Server.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AccountResponse"},{"$ref":"#/components/schemas/DetailedAccountResponse"}]}}}}}},"put":{"tags":["security"],"summary":"Replace an account","description":"Replace an account. If a password is not supplied, then the password for this account will not be updated.","operationId":"replaceAccount","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["security"],"summary":"Delete an account","description":"Delete an account given the ID","operationId":"deleteAccount_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"newOwner","in":"query","description":"The ID of the account that will own the items originally owned by this account. If not specified, then all items originally owned by this account will be owned by the current user.","required":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/roles":{"get":{"tags":["security"],"summary":"Get user roles","description":"Get the user roles of an account by its unique identifier","operationId":"getRoles_4","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountRoleAssignmentResponse"}}}}}}},"put":{"tags":["security"],"summary":"Replace the roles assigned to an account","description":"Replaces all of the roles that are assigned to an account with new roles.","operationId":"replaceRoles","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Roles to assign to the account","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["security"],"summary":"Assign roles to an account","description":"Assigns roles to an account.","operationId":"assignRoles","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Roles to assign to the account","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/passwordchangeneeded":{"put":{"tags":["security"],"summary":"Require password change for an account","description":"Forces a user to change their password on next login. This only applies to System accounts and does not affect the user invoking this endpoint.","operationId":"updatePasswordChangeNeeded","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeNeededRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/password":{"put":{"tags":["security"],"summary":"Update the password of an account","description":"Update the password of an account","operationId":"updatePassword_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/items":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for all security items","description":"Retrieves permissions for all security items for the user account","operationId":"getAllItemPermissions_2","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"query","description":"If specified, only items in this category will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionPage"}}}}}},"put":{"tags":["permissions"],"summary":"Update permissions for security items","description":"Updates permissions for security items for the user account. Only the items supplied in the request body will be updated, permissions for all other items not supplied in the request body will not be updated. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"replaceItemPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateItemPermissionRequest"}}}},"required":true},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the update operation, indicating success or error status for each item permission update."}}}},"/accounts/{id}/items/{category}/{item}/permissions":{"put":{"tags":["permissions"],"summary":"Update permissions for a security item","description":"Updates permissions for a security item for the user account. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"replaceSingleItemPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["permissions"],"summary":"Grant permissions for a security item","description":"Grants permissions for a security item for the user account. Existing permissions are not removed. Use method GET /permissions/metadata/items to retrieve the item permissions available on FME Flow.","operationId":"grantSingleItemPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["permissions"],"summary":"Revoke permissions for a security item","description":"Revokes permissions for a security item for the user account.","operationId":"revokeSingleItemPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/enabled":{"put":{"tags":["security"],"summary":"Enable/Disable an account","description":"Set the enabled state for the account","operationId":"enableAccount","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountEnableRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/email":{"put":{"tags":["security"],"summary":"Update the email of an account","description":"Update the email of an account","operationId":"updateEmail","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/categories":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for all security categories","description":"Retrieves permissions for all security categories for the user account","operationId":"getAllCategoryPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryPermissionResponse"}}}}}}},"put":{"tags":["permissions"],"summary":"Update permissions for security categories","description":"Updates permissions for security categories for the user account. Only the categories supplied in the request body will be updated, permissions for all other categories not supplied in the request body will not be updated. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"replaceCategoryPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UpdateCategoryPermissionRequest"}}}},"required":true},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the update operation, indicating success or error status for each category permissions update."}}}},"/accounts/{id}/categories/{category}/permissions":{"put":{"tags":["permissions"],"summary":"Update permissions for a security category","description":"Updates permissions for a security category for the user account. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"replaceSingleCategoryPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"post":{"tags":["permissions"],"summary":"Grant permissions for a security category","description":"Grants permissions for a security category for the user account. Existing permissions are not removed. Use method GET /permissions/metadata/categories to retrieve the category permissions available on FME Flow.","operationId":"grantSingleCategoryPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security permissions","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["permissions"],"summary":"Revoke permissions for a security category","description":"Revokes permissions for a security category for the user account.","operationId":"revokeSingleCategoryPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/workspaces/{repository}/{workspace}/statistics/reset":{"post":{"tags":["repositories"],"summary":"Reset workspace job statistics","operationId":"resetStatistics","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/workspaces/{repository}/{workspace}/resources":{"get":{"tags":["repositories"],"summary":"Retrieve resources","description":"Retrieve resources for a workspace","operationId":"getWorkspaceResources","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}}}}}},"post":{"tags":["repositories"],"summary":"Upload resource files","description":"Uploads resource files to the workspace. Each multipart part contains the resource file and each multipart part specifies the filename in its 'Content-Disposition' header.","operationId":"upload","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}},{"name":"overwrite","in":"query","description":"Whether to overwrite files of the same name if they exist.","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["files"],"type":"object","properties":{"files":{"type":"array","description":"Resource files","items":{"type":"string","format":"binary"}}}}}}},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the upload operation, indicating success or error status for each file."}}}},"/workspaces/{repository}/upload":{"post":{"tags":["repositories"],"summary":"Publish multiple workspaces to a repository","description":"Publishes multiple workspaces to a repository. Each multipart part contains the workspace contents, and specifies the file name in its 'Content-Disposition' header. Note that this endpoint does not support the following: Publishing data files, custom transformers, custom formats, templates, database connections, web connections, or packages associated with workspaces. To publish workspaces to FME Flow with support for any of these features, use the \"Publish to FME Flow\" wizard from the FME Form. For more information, see \"Publishing to FME Flow\" in the FME Form Help.","operationId":"upload_1","parameters":[{"name":"repository","in":"path","description":"Name of a repository","required":true,"schema":{"type":"string"}},{"name":"overwrite","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["files"],"type":"object","properties":{"files":{"type":"array","description":"Set of workspaces to publish to the repository. Workspaces must be of format `.fmw`.","items":{"type":"string","format":"binary"}}}}}}},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the upload operation, indicating success or error status for each file."}}}},"/workspaces/{repository}/downloadzip":{"post":{"tags":["repositories"],"summary":"Download multiple workspace files in a zip file","description":"Downloads multiple workspace files in a zip file. This web page will only display the response body automatically, and include the option to download the file above the header.","operationId":"downloadWorkspacesZip","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadWorkspacesRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/topics":{"get":{"tags":["notifications"],"summary":"Retrieve a list of topics","description":"Retrieves a list of topics. Only superusers can filter topics by the ID of another user.","operationId":"getTopics","parameters":[{"name":"ownerID","in":"query","description":"If included, returns only topics owned by the owner with the specified UUID","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only topics with a matching name or owner will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","owner"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TopicPage"}}}}}},"post":{"tags":["notifications"],"summary":"Create new topic","description":"Adds a new topic to the FME Flow instance.","operationId":"createTopic","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTopicRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/topics/{name}/message":{"post":{"tags":["notifications"],"summary":"Publish a JSON message to a topic.","description":"Sends a JSON message to the specified topic. Nested JSON objects and arrays are not supported. The provided JSON will be used to override valid subscription settings where possible, and will otherwise be ignored.","operationId":"publishSubscriberSettings","parameters":[{"name":"name","in":"path","description":"Name of the topic to publish to.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The message to publish","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/topics/{name}/message/subscribercontent":{"post":{"tags":["notifications"],"summary":"Publish to the subscriber_content message key.","description":"Sends a message to the specified topic regardless of media type. The message is stored in the 'subscriber_content' key of the notification message.","operationId":"publishSubscriberContent","parameters":[{"name":"name","in":"path","description":"Name of the topic to publish to.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The message to publish to the subscriber_content message key","content":{"*/*":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/tokens":{"get":{"tags":["tokens"],"summary":"Retrieve tokens","description":"Retrieve all tokens","operationId":"getTokens","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"ownerID","in":"query","description":"The UUID of the user that owns the token","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"type","in":"query","description":"The token type","required":false,"schema":{"type":"string","enum":["api","session"]}},{"name":"expired","in":"query","description":"Whether the token has expired or not","required":false,"schema":{"type":"boolean"}},{"name":"filterString","in":"query","description":"If specified, only tokens with matching names or descriptions will be returned ","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the filterString to the specified properties","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","description"]}}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, `name_asc` to sort by name in ascending order. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `name` in ascending order by default. Sorting is only supported on `name` and `expiration`","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TokenPage"}}}}}},"post":{"tags":["tokens"],"summary":"Create a new token","description":"Creates a new token. Either `secondsToExpiry` or `expiration` must be specified, but not both. The generated token is returned in the response body.","operationId":"createToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTokenRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NewTokenResponse"}}}}}}},"/subscriptions":{"get":{"tags":["notifications"],"summary":"Retrieve a list of subscriptions","operationId":"getSubscriptions","parameters":[{"name":"ownerID","in":"query","description":"If included, returns only subscriptions owned by the owner with the specified UUID","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only subscriptions with a matching name or owner will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","owner"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SubscriptionPage"}}}}}},"post":{"tags":["notifications"],"summary":"Create a new subscription","operationId":"createSubscription","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NewDropboxSubscriptionRequest"},{"$ref":"#/components/schemas/NewEmailSubscriptionRequest"},{"$ref":"#/components/schemas/NewEventGridSubscriptionRequest"},{"$ref":"#/components/schemas/NewFtpSubscriptionRequest"},{"$ref":"#/components/schemas/NewHttpSubscriptionRequest"},{"$ref":"#/components/schemas/NewJmsSubscriptionRequest"},{"$ref":"#/components/schemas/NewLoggerSubscriptionRequest"},{"$ref":"#/components/schemas/NewS3SubscriptionRequest"},{"$ref":"#/components/schemas/NewSftpSubscriptionRequest"},{"$ref":"#/components/schemas/NewSnsSubscriptionRequest"},{"$ref":"#/components/schemas/NewSqsSubscriptionRequest"},{"$ref":"#/components/schemas/NewWebSocketSubscriptionRequest"},{"$ref":"#/components/schemas/NewWorkspaceSubscriptionRequest"}]}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/subscriptions/{subscription}/test":{"post":{"tags":["notifications"],"summary":"Validate an existing subscription definition","description":"Validates an existing subscription definition.\n\nIf a request body is supplied, the properties given in the request body will be validated.\n\nIf a request body is not supplied, the existing properties for the given subscription will be validated.\n","operationId":"testExistingSubscription","parameters":[{"name":"subscription","in":"path","description":"Name of the subscription to test","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TestExistingDropboxSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingEmailSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingEventGridSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingFtpSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingHttpSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingJmsSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingLoggerSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingS3SubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingSftpSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingSnsSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingSqsSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingWebSocketSubscriptionRequest"},{"$ref":"#/components/schemas/TestExistingWorkspaceSubscriptionRequest"}]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestStatus"}}}}}}},"/subscriptions/test":{"post":{"tags":["notifications"],"summary":"Validate the subscription definition.","operationId":"testSubscription","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TestDropboxSubscriptionRequest"},{"$ref":"#/components/schemas/TestEmailSubscriptionRequest"},{"$ref":"#/components/schemas/TestEventGridSubscriptionRequest"},{"$ref":"#/components/schemas/TestFtpSubscriptionRequest"},{"$ref":"#/components/schemas/TestHttpSubscriptionRequest"},{"$ref":"#/components/schemas/TestJmsSubscriptionRequest"},{"$ref":"#/components/schemas/TestLoggerSubscriptionRequest"},{"$ref":"#/components/schemas/TestS3SubscriptionRequest"},{"$ref":"#/components/schemas/TestSftpSubscriptionRequest"},{"$ref":"#/components/schemas/TestSnsSubscriptionRequest"},{"$ref":"#/components/schemas/TestSqsSubscriptionRequest"},{"$ref":"#/components/schemas/TestWebSocketSubscriptionRequest"},{"$ref":"#/components/schemas/TestWorkspaceSubscriptionRequest"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestStatus"}}}}}}},"/streams":{"get":{"tags":["streams"],"summary":"Retrieve streams","description":"Retrieves all streams configured on the FME Flow instance","operationId":"list","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"includeEngineInfo","in":"query","description":"Whether to include information about engines assigned to the stream","required":false,"schema":{"type":"boolean","default":false}},{"name":"filterString","in":"query","description":"If specified, only streams with a matching name or owner will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the filterString to the specified properties","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamPage"}}}}}},"post":{"tags":["streams"],"summary":"Create a new stream","description":"Creates a new stream given the information in the request body","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewStreamRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/schedules":{"get":{"tags":["schedules"],"summary":"Retrieve schedule summaries","description":"Retrieve summaries of all schedules","operationId":"getSchedules","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"ownerID","in":"query","description":"Specifies the UUID (unique identifier) of the owner of the schedule","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"tag","in":"query","description":"Schedules tagged with the specified tag will be returned.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, `name_asc` to sort by `name` in ascending order. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `begin` in descending order by default. Sorting is only supported on `name` and `begin`","required":false,"schema":{"type":"string","default":""}},{"name":"filterString","in":"query","description":"If specified, only schedules with a matching name or workspace will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","workspace"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleSummaryPage"}}}}}},"post":{"tags":["schedules"],"summary":"Create a new schedule","description":"Creates a schedule to run a workspace on FME Flow. The schedule can run the workspace immediately, at a later time, intermittently, once only, or according to a CRON expression.","operationId":"createSchedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewScheduleRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/schedules/{id}/trigger":{"post":{"tags":["schedules"],"summary":"Immediately trigger a schedule","description":"Immediately triggers an existing schedule. The schedule can be enabled or disabled.","operationId":"trigger","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the schedule","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/schedules/{id}/statistics/reset":{"post":{"tags":["schedules"],"summary":"Reset the schedule statistics","description":"Resets the schedule statistics from FME Flow.","operationId":"resetStatistics_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the schedule","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/schedules/tags":{"get":{"tags":["schedules"],"summary":"Retrieve schedule tags","operationId":"list_3","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only tags with matching names will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TagPage"}}}}}},"post":{"tags":["schedules"],"summary":"Create a new schedule tag","operationId":"create_2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/saml":{"get":{"tags":["authentication services"],"summary":"Retrieve all SAML configurations","operationId":"getSAMLConfigs","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SAMLConfigPage"}}}}}},"post":{"tags":["authentication services"],"summary":"Create a SAML configuration","operationId":"createSAMLConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSAMLConfigRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/saml/{id}/spkey":{"post":{"tags":["authentication services"],"summary":"Uploads service provider key","operationId":"uploadServiceProviderKey","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"SAML service provider key file","format":"binary"}}}}}},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Deletes service provider key","operationId":"deleteServiceProviderKey","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/saml/{id}/spcertificate":{"post":{"tags":["authentication services"],"summary":"Uploads service provider certificate","operationId":"uploadServiceProviderCertificate","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"SAML service provider certificate file","format":"binary"}}}}}},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Deletes service provider certificate","operationId":"deleteServiceProviderCertificate","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/saml/{id}/idpmetadata":{"post":{"tags":["authentication services"],"summary":"Uploads identity provider metadata","operationId":"uploadIdentityProviderMetadata","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"SAML identity provider metadata file","format":"binary"}}}}}},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Deletes identity provider metadata","operationId":"deleteIdentityProviderMetadata","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/saml/{id}/idpcertificate":{"post":{"tags":["authentication services"],"summary":"Uploads identity provider certificate","operationId":"uploadIdentityProviderCertificate","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"SAML identity provider certificate file","format":"binary"}}}}}},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["authentication services"],"summary":"Deletes identity provider certificate","operationId":"deleteIdentityProviderCertificate","parameters":[{"name":"id","in":"path","description":"ID of the SAML configuration.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/roles":{"get":{"tags":["security"],"summary":"Retrieve roles","description":"Retrieve all roles","operationId":"getRoles","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"summary","in":"query","description":"If true, role summaries are returned. Summaries exclude sensitive information such as accounts. Default is `true`.","required":false,"schema":{"type":"boolean","default":true}},{"name":"serverName","in":"query","description":"If specified, only roles imported from this Directory Server will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterString","in":"query","description":"If specified, only roles with a matching name will be returned. If the `summary` parameter is `false`, then roles with matching accounts will also be returned. \n\nNote: All other query parameters applied to this request will be used in conjunction with the `filterString` parameter.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","account"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RolePage"}}}}}},"post":{"tags":["security"],"summary":"Create a new role","description":"Creates a new role","operationId":"createRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRoleRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/resources/test/connections":{"post":{"tags":["resources"],"summary":"Test new resource connection definition","description":"Performs a test on a resource connection definition to see if the definition is valid.","operationId":"test","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestNewSharedResourceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestStatus"}}}}}}},"/resources/test/connections/{connection}":{"post":{"tags":["resources"],"summary":"Test a resource connection","description":"Performs a test on an existing resource connection with different settings to see if the resulting connection is valid. If a password or secret key is not supplied, then the password or secret key for this resource connection will not be overridden.","operationId":"testExisting","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSharedResourceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestStatus"}}}}}}},"/resources/connections":{"get":{"tags":["resources"],"summary":"Retrieve resource connections","description":"Retrieves all resource connections configured on the FME Flow instance.","operationId":"listConnections","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"ownerID","in":"query","description":"If specified, only resource connections owned by the specified user will be returned.","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"type","in":"query","description":"If specified, only resource connections with the specified types will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["file","awsS3","network"]}}},{"name":"filterString","in":"query","description":"If specified, only resource connections with matching name or display name will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the filterString to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","displayName"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SharedResourcePage"}}}}}},"post":{"tags":["resources"],"summary":"Create a resource connection","description":"Creates a resource connection. Use method GET /resources/types to retrieve the valid types of resources and valid properties for each type. Creating file resource is not supported.","operationId":"createConnection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSharedResourceRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/resources/connections/{connection}/upload":{"post":{"tags":["resources"],"summary":"Upload files","description":"Uploads files to the resource connection. Each multipart part contains the file contents and each multipart part specifies the filename in its 'Content-Disposition' header. Relative path names are permitted in the content-disposition header filename field, and files will be placed within these sub-directories.","operationId":"upload_2","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}},{"name":"overwrite","in":"query","description":"Whether to overwrite files of the same name if they exist.","required":false,"schema":{"type":"boolean","default":false}},{"name":"path","in":"query","description":"Path, relative to the resource connection (for example, /foo/bar/test.file).","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["files"],"type":"object","properties":{"files":{"type":"array","description":"Resource files","items":{"type":"string","format":"binary"}}}}}}},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the upload operation, indicating success or error status for each file."}}}},"/resources/connections/{connection}/rename":{"post":{"tags":["resources"],"summary":"Rename a file or directory","description":"Renames a file or directory.","operationId":"rename","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameRequest"}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/resources/connections/{connection}/move":{"post":{"tags":["resources"],"summary":"Move files to another location","description":"Moves files from one location to another location on the same or another resource connection.","operationId":"move","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"207":{"description":"The response body contains information about the result of the move operation, indicating success or error status for each item."}}}},"/resources/connections/{connection}/downloadzip":{"post":{"tags":["resources"],"summary":"Download zip file","description":"Downloads one or more files from a resource connection either as an attachment.  If more than one file is selected, the specified files will be downloaded as a single zip file. This web page will only display the response body instead of downloading the file, so REST clients should inspect the Content-Disposition header and handle the download.","operationId":"postDownloadZip","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadResourceFilesRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/resources/connections/{connection}/download":{"get":{"tags":["resources"],"summary":"Download file","description":"Downloads a file from a resource connection.","operationId":"downloadFile","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Path, relative to the resource connection (for example, /foo/bar/test.file).","required":true,"schema":{"type":"string"}},{"name":"disposition","in":"query","description":"Specifies how to retrieve the resource using the 'Content-Disposition' header.  This parameter is only relevant for some REST clients (primarily web browsers).  If no disposition is selected, then a header is not set.","required":false,"schema":{"type":"string","enum":["inline","attachment"]}}],"responses":{"200":{"description":"OK"}}},"post":{"tags":["resources"],"summary":"Download file","description":"Downloads a file from a resource connection either as an inline resource or as an attachment.  The `disposition` parameter is only relevant for some REST clients.  In particular, Internet Explorer behaves poorly without an attachment disposition header. This web page will only display the response body instead of downloading the file, so REST clients should inspect the Content-Disposition header and handle the download.","operationId":"postDownload","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadFileRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/resources/connections/{connection}/directory":{"post":{"tags":["resources"],"summary":"Create a directory","description":"Creates a directory on the resource connection.","operationId":"createDir","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewDirectoryRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SharedResourceFileInfoResponse"}}}}}}},"/resources/connections/{connection}/delete":{"post":{"tags":["resources"],"summary":"Remove files or directories","description":"Removes multiple files or directories from the resource connection.","operationId":"removeBatch","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"207":{"description":"The response body contains information about the result of the remove operation, indicating success or error status for each item."}}}},"/resources/connections/{connection}/copy":{"post":{"tags":["resources"],"summary":"Copy files to another location","description":"Copies files from one location to another location on the same or another resource connection.","operationId":"copy","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"207":{"description":"The response body contains information about the result of the copy operation, indicating success or error status for each item."}}}},"/repositories":{"get":{"tags":["repositories"],"summary":"Retrieve repositories","description":"Retrieve all repositories","operationId":"getRepositories","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"ownerID","in":"query","description":"If specified, only repositories owned by the specified user will be returned.","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"filterString","in":"query","description":"If specified, only repositories with matching name, description or owner will be returned. \n\nNote: All other query parameters applied to this request will be used in conjunction with the `filterString` parameter.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","description","owner"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RepositoryPage"}}}}}},"post":{"tags":["repositories"],"summary":"Create a new repository","description":"Creates a new repository","operationId":"createRepository","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewRepositoryRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/repositories/{repository}/items/{item}/resources":{"get":{"tags":["repositories"],"summary":"Retrieve resources","description":"Retrieve resources for a repository item","operationId":"getRepositoryItemResources","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}}}}}},"post":{"tags":["repositories"],"summary":"Upload resource files","description":"Uploads resource files to the repository item. Each multipart part contains the resource file and each multipart part specifies the filename in its 'Content-Disposition' header.","operationId":"upload_3","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}},{"name":"overwrite","in":"query","description":"Whether to overwrite files of the same name if they exist.","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["files"],"type":"object","properties":{"files":{"type":"array","description":"Resource files","items":{"type":"string","format":"binary"}}}}}}},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the upload operation, indicating success or error status for each file."}}}},"/repositories/{repository}/items/upload":{"post":{"tags":["repositories"],"summary":"Publish multiple items to a repository","description":"Publishes multiple items to a repository. Each multipart part contains the item contents, and specifies the file name in its 'Content-Disposition' header. Note that this endpoint does not support the following: Publishing data files, database connections, web connections, or packages associated with workspaces. To publish workspaces to FME Flow with support for any of these features, use the \"Publish to FME Flow\" wizard from the FME Form. For more information, see \"Publishing to FME Flow\" in the FME Form Help.","operationId":"upload_4","parameters":[{"name":"repository","in":"path","description":"Name of a repository","required":true,"schema":{"type":"string"}},{"name":"overwrite","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["files"],"type":"object","properties":{"files":{"type":"array","description":"Set of items to publish to the repository. Repository items must be of format `.fmw`, `.fds`, `.fmx`, or `.fmwt`.","items":{"type":"string","format":"binary"}}}}}}},"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the upload operation, indicating success or error status for each file."}}}},"/repositories/{repository}/items/downloadzip":{"post":{"tags":["repositories"],"summary":"Download multiple repository item files in a zip file","description":"Downloads multiple repository item files in a zip file. This web page will only display the response body automatically, and include the option to download the file above the header.","operationId":"downloadRepositoryItemsZip","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadItemsRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/remoteengines":{"get":{"tags":["remote engines"],"summary":"Retrieve Remote Engine connections","description":"Retrieve all Remote Engine connections","operationId":"getConnections","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RemoteEngineConnectionPage"}}}}}},"post":{"tags":["remote engines"],"summary":"Create a new Remote Engine connection","description":"Creates a new Remote Engine connection","operationId":"createConnection_1","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NewRemoteEngineConnectionRequest"},{"$ref":"#/components/schemas/NewRemoteEngineConnectionRequestSnowflake"}]}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/remoteengines/{id}/test":{"post":{"tags":["remote engines"],"summary":"Test an existing Remote Engine connection","description":"Tests an existing Remote Engine connection. Any properties supplied in the request will override existing properties.","operationId":"testExisting_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TestExistingRemoteEngineConnectionRequest"},{"$ref":"#/components/schemas/TestExistingRemoteEngineConnectionRequestSnowflake"}]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestConnectionStatusResponse"}}}}}}},"/remoteengines/{id}/generatetoken":{"post":{"tags":["remote engines"],"summary":"Generate a new token","description":"Generates a new API token for the Remote Engine. The generated token will have all permissions granted to the user that is used to authenticate the remote engine connection. The generated token is returned in the response body.","operationId":"generateToken","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateTokenRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenerateTokenResponse"}}}}}}},"/remoteengines/test":{"post":{"tags":["remote engines"],"summary":"Test a new Remote Engine connection","operationId":"test_1","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TestRemoteEngineConnectionRequest"},{"$ref":"#/components/schemas/TestRemoteEngineConnectionRequestSnowflake"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestConnectionStatusResponse"}}}}}}},"/queues":{"get":{"tags":["enginemanagement"],"summary":"Retrieve queues","description":"Retrieve all queues","operationId":"getQueues","parameters":[{"name":"type","in":"query","description":"If specified, only queues of this type will be returned.","required":false,"schema":{"type":"string","enum":["system","remote"]}},{"name":"jobStatus","in":"query","description":"If specified, only queues with jobs of this status will be returned.","required":false,"schema":{"type":"string","enum":["running","queued"]}},{"name":"engineType","in":"query","description":"If specified, only queues assigned to this engine type will be returned.","required":false,"schema":{"type":"string","enum":["standard","dynamic"]}},{"name":"filterString","in":"query","description":"If specified, only queues with a matching name or assigned engine will be returned.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, `name_asc` to sort by name in ascending order. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `name` in ascending order by default. Sorting is supported for `name`, `priority`, `runningJobs`, `completedJobs`, and `queuedJobs`. Note that sorting by `completedJobs` considers all jobs that completed with a status of either `success`, `failure`, or `cancelled`.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/QueuePage"}}}}}},"post":{"tags":["enginemanagement"],"summary":"Create a new queue","description":"Creates a new queue","operationId":"createQueue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewQueueRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/queues/statistics/reset":{"post":{"tags":["enginemanagement"],"summary":"Reset queue statistics","operationId":"resetStatistics_2","responses":{"204":{"description":"No Content"}}}},"/publications":{"get":{"tags":["notifications"],"summary":"Retrieve a list of publications","operationId":"getPublications","parameters":[{"name":"ownerID","in":"query","description":"If included, returns only publications owned by the owner with the specified UUID","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only publications with a matching name or owner will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","owner"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PublicationPage"}}}}}},"post":{"tags":["notifications"],"summary":"Create a new publication","operationId":"createPublication","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NewDirWatchPublicationRequest"},{"$ref":"#/components/schemas/NewDropboxWatchPublicationRequest"},{"$ref":"#/components/schemas/NewEventGridPublicationRequest"},{"$ref":"#/components/schemas/NewFtpWatchPublicationRequest"},{"$ref":"#/components/schemas/NewImapPublicationRequest"},{"$ref":"#/components/schemas/NewJmsPublicationRequest"},{"$ref":"#/components/schemas/NewS3WatchPublicationRequest"},{"$ref":"#/components/schemas/NewSmtpPublicationRequest"},{"$ref":"#/components/schemas/NewSnsPublicationRequest"},{"$ref":"#/components/schemas/NewSqsPublicationRequest"},{"$ref":"#/components/schemas/NewUdpPublicationRequest"},{"$ref":"#/components/schemas/NewWebSocketPublicationRequest"}]}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/publications/{publication}/test":{"post":{"tags":["notifications"],"summary":"Validate an existing publication definition","description":"Validate an existing publication definition.\n\nIf a request body is supplied, the properties given in the request body will be validated.\n\nIf a request body is not supplied, the existing properties for the given publication will be validated.\n","operationId":"testExistingPublication","parameters":[{"name":"publication","in":"path","description":"Name of the publication to test","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TestExistingDirWatchPublicationRequest"},{"$ref":"#/components/schemas/TestExistingDropboxWatchPublicationRequest"},{"$ref":"#/components/schemas/TestExistingEventGridPublicationRequest"},{"$ref":"#/components/schemas/TestExistingFtpWatchPublicationRequest"},{"$ref":"#/components/schemas/TestExistingImapPublicationRequest"},{"$ref":"#/components/schemas/TestExistingJmsPublicationRequest"},{"$ref":"#/components/schemas/TestExistingS3WatchPublicationRequest"},{"$ref":"#/components/schemas/TestExistingSmtpPublicationRequest"},{"$ref":"#/components/schemas/TestExistingSnsPublicationRequest"},{"$ref":"#/components/schemas/TestExistingSqsPublicationRequest"},{"$ref":"#/components/schemas/TestExistingUdpPublicationRequest"},{"$ref":"#/components/schemas/TestExistingWebSocketPublicationRequest"}]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestStatus"}}}}}}},"/publications/test":{"post":{"tags":["notifications"],"summary":"Validate the publication definition","operationId":"testPublication","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TestDirWatchPublicationRequest"},{"$ref":"#/components/schemas/TestDropboxWatchPublicationRequest"},{"$ref":"#/components/schemas/TestEventGridPublicationRequest"},{"$ref":"#/components/schemas/TestFtpWatchPublicationRequest"},{"$ref":"#/components/schemas/TestImapPublicationRequest"},{"$ref":"#/components/schemas/TestJmsPublicationRequest"},{"$ref":"#/components/schemas/TestS3WatchPublicationRequest"},{"$ref":"#/components/schemas/TestSmtpPublicationRequest"},{"$ref":"#/components/schemas/TestSnsPublicationRequest"},{"$ref":"#/components/schemas/TestSqsPublicationRequest"},{"$ref":"#/components/schemas/TestUdpPublicationRequest"},{"$ref":"#/components/schemas/TestWebSocketPublicationRequest"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestStatus"}}}}}}},"/projects":{"get":{"tags":["projects"],"summary":"Retrieve projects","description":"Retrieve all projects on the FME Flow instance","operationId":"list_5","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only projects with matching name, description or owner will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","description","owner"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectPage"}}}}}},"post":{"tags":["projects"],"summary":"Create a new project","description":"Creates a new project given the information in the request body","operationId":"create_3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewProjectRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/projects/{id}/items":{"get":{"tags":["projects"],"summary":"Retrieve project items","description":"Retrieve all items belonging to the specified project","operationId":"list_6","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"type","in":"query","description":"If specified, only project items with one of the specified types will be returned.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectItemType"}}},{"name":"filterString","in":"query","description":"If specified, only project items with matching name or owner will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","owner"]}}},{"name":"includeDependencies","in":"query","description":"Whether to include the dependencies of the project items","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectItemsPage"}}}}}},"post":{"tags":["projects"],"summary":"Add a resource to a project","description":"Adds a resource to a project","operationId":"addItem","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewProjectItemRequest"}}},"required":true},"responses":{"204":{"description":"Success. The resource was added to the project."}}}},"/projects/{id}/items/test":{"post":{"tags":["projects"],"summary":"Test project items","description":"Test validity of all items belonging to the specified project","operationId":"test_2","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"permissions","in":"query","description":"Item permissions to test","required":true,"schema":{"type":"array","items":{"type":"string","enum":["read","delete"]}}}],"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the test operation, indicating success or error status for each operation."}}}},"/projects/{id}/items/batch/delete":{"post":{"tags":["projects"],"summary":"Delete project items","description":"Delete a list of items from a project","operationId":"deleteProjectItems","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteProjectItemRequest"}}},"required":true},"responses":{"204":{"description":"If they existed, the items were deleted."},"207":{"description":"The response body contains information about the result of the delete operation, indicating success or error status for each operation."}}}},"/projects/{id}/items/batch/add":{"post":{"tags":["projects"],"summary":"Add resources to a project","description":"Adds all the specified resources to a project","operationId":"batchAddItems","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchNewProjectItemRequest"}}},"required":true},"responses":{"204":{"description":"Success. All resources were added to the project."},"207":{"description":"The response body contains information about the result of the add operation, indicating success or error status for each operation."}}}},"/projects/{id}/export/resource":{"post":{"tags":["projects"],"summary":"Export a project as a resource","description":"Exports a project to a resource folder. The export is asynchronous, the ID of the running task is returned immediately regardless of task status.","operationId":"asyncExportJson","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAsyncExportRequest"}}},"required":true},"responses":{"202":{"description":"Success. The export has started. A task ID is rendered in the response body.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExportTaskResponse"}}}}}}},"/projects/{id}/export/download":{"post":{"tags":["projects"],"summary":"Export a project as a download","description":"Exports a project as a download. The exported package will be returned in the response along with the task ID in the \"FME-Flow-Task-ID\" response header.","operationId":"syncExportJson","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectExportRequest"}}},"required":true},"responses":{"200":{"description":"Success. The export package is returned in the response body, and the task ID is returned in the \"FME-Flow-Task-ID\" response header."}}}},"/projects/imports/{id}/run":{"post":{"tags":["projects"],"summary":"Run a ready import","description":"Runs an import with either a generated preview or a quick import","operationId":"run","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSettingsRequest"}}},"required":true},"responses":{"202":{"description":"Accepted"}}}},"/projects/imports/{id}/regenerate":{"post":{"tags":["projects"],"summary":"Regenerates a preview","description":"Will regenerate preview if it exists, or generate a preview for a quick import","operationId":"regenerate","parameters":[{"name":"id","in":"path","description":"Specifies the ID of the project","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"202":{"description":"Accepted"}}}},"/projects/imports/upload":{"post":{"tags":["projects"],"summary":"Upload a new import file","description":"Accepts a project (.fsproject) file for import","operationId":"upload_5","parameters":[{"name":"skipPreview","in":"query","description":"If true, generate a quick import without a preview. Less time consuming as no dry run is needed.","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The .fsproject file to import","format":"binary"}}}}}},"responses":{"201":{"description":"Created"}}}},"/projects/imports/resource":{"post":{"tags":["projects"],"summary":"Import from shared resource","description":"Imports a project from a shared resource location","operationId":"createImportFromResource","requestBody":{"description":"Resource containing the import package","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportFromResourceRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/packages":{"get":{"tags":["packages"],"summary":"Retrieve packages","description":"Retrieves all packages uploaded to the FME Flow instance","operationId":"list_10","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only packages with matching names or descriptions will be returned ","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the filterString to the specified properties","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","id"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PagePackageResponse"}}}}}},"post":{"tags":["packages"],"summary":"Create or update a package","description":"Creates a new package from the uploaded file, or updates the existing package if a version of the package already exists","operationId":"create_4","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Package file","format":"binary"}}}}}},"responses":{"201":{"description":"Created"}}}},"/migrations/restore/upload":{"post":{"tags":["migrations"],"summary":"System restore from downloaded package","description":"Accepts a downloaded package (.fsconfig) file for system restore. The restore is asynchronous, the ID of the task is returned immediately regardless of task status.","operationId":"restoreUpload","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","request"],"type":"object","properties":{"file":{"type":"string","description":"The .fsconfig file to restore","format":"binary"},"request":{"$ref":"#/components/schemas/MigrationRestoreUploadRequest"}}}}}},"responses":{"202":{"description":"Success. The restore has started. A task ID is rendered in the response body.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrationTaskIdResponse"}}}}}}},"/migrations/restore/resource":{"post":{"tags":["migrations"],"summary":"System restore from a resource","description":"Accepts a package (.fsconfig) from a resource location for system restore. The restore is asynchronous, the ID of the task is returned immediately regardless of task status.","operationId":"restoreResource","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationRestoreResourceRequest"}}},"required":true},"responses":{"202":{"description":"Success. The restore has started. A task ID is rendered in the response body.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrationTaskIdResponse"}}}}}}},"/migrations/backup/resource":{"post":{"tags":["migrations"],"summary":"System backup as a resource","description":"System backup to a resource folder. The backup is asynchronous, the ID of the task is returned immediately regardless of task status.","operationId":"backupResource","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationBackupResourceRequest"}}},"required":true},"responses":{"202":{"description":"Success. The backup has started. A task ID is rendered in the response body.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrationTaskIdResponse"}}}}}}},"/migrations/backup/download":{"post":{"tags":["migrations"],"summary":"System backup as a download","description":"System backup as a download. The exported package will be returned in the response along with the task ID in the \"FME-Flow-Task-ID\" response header.","operationId":"backupDownload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationBackupDownloadRequest"}}},"required":true},"responses":{"200":{"description":"Success. The exported package is returned in the response body, and the task ID is returned in the \"FME-Flow-Task-ID\" response header."}}}},"/license":{"post":{"tags":["licensing"],"summary":"Install a license file","description":"Installs a license file to FME Flow.","operationId":"installLicense","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The license file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseStatusResponse"}}}}}}},"/license/requestfile":{"post":{"tags":["licensing"],"summary":"Download a JSON file for requesting a FME Flow license","description":"Downloads a JSON file for requesting a FME Flow license file.","operationId":"requestFileDownload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseFileRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/license/request":{"post":{"tags":["licensing"],"summary":"Install a license file from Safe Software","description":"Installs a license file from Safe Software.","operationId":"requestLicense","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseRequest"}}},"required":true},"responses":{"202":{"description":"The request to install a license file has been accepted."}}}},"/license/refresh":{"post":{"tags":["licensing"],"summary":"Refresh a license file from Safe Software","description":"Refreshes a license file from Safe Software.","operationId":"refreshLicense","responses":{"202":{"description":"The request to refresh the license has been accepted."}}}},"/ldap/{id}/synchronize":{"post":{"tags":["authentication services"],"summary":"Synchronize with an LDAP server","operationId":"synchronize","parameters":[{"name":"id","in":"path","description":"ID of the LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/ldap/{id}/importuser":{"post":{"tags":["authentication services"],"summary":"Import an LDAP user","operationId":"importUser","parameters":[{"name":"id","in":"path","description":"ID of the LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportUserRequest"}}},"required":true},"responses":{"204":{"description":"Success. The LDAP user was imported."}}}},"/ldap/{id}/importrole":{"post":{"tags":["authentication services"],"summary":"Import an LDAP role","description":"Imports an LDAP role. All member LDAP user accounts will also be imported.","operationId":"importRole","parameters":[{"name":"id","in":"path","description":"ID of the LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportRoleRequest"}}},"required":true},"responses":{"204":{"description":"No Content","content":{"*/*":{"schema":{"type":"object"}}}},"207":{"description":"The response body contains information about the result of the import operation, indicating error status for each LDAP user that was not imported."}}}},"/ldap/windows":{"get":{"tags":["authentication services"],"summary":"Retrieve all Windows LDAP servers","operationId":"getWindowsServers","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WindowsLdapServerPage"}}}}}},"post":{"tags":["authentication services"],"summary":"Create a Windows LDAP server","operationId":"createWindowsServer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewWindowsLdapServerRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/ldap/generic":{"get":{"tags":["authentication services"],"summary":"Retrieve all generic LDAP servers","operationId":"getGenericServers","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GenericLdapServerPage"}}}}}},"post":{"tags":["authentication services"],"summary":"Create a generic LDAP server","operationId":"createGenericServer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewGenericLdapServerRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/jobs":{"get":{"tags":["jobs"],"summary":"Retrieve all jobs","description":"Retrieves the records for all jobs of the given status.","operationId":"getJobs","parameters":[{"name":"status","in":"query","description":"Jobs matching any of the specified statuses will be returned.","required":true,"schema":{"type":"array","items":{"type":"string","enum":["queued","running","success","failure","cancelled"]}}},{"name":"runtimeUserID","in":"query","description":"If specified, only jobs run by the specified user will be returned. When a job runs in the context of these FME Flow mechanisms, `runtimeUserID` means the following:\n* Automation (no manual trigger): The user that last enabled the automation to run the job.\n* Automation (with manual trigger): The user that manually triggered the automation to run the job.\n* FME Flow Web Services: The user that ran the job.\n* Schedule: (no manual trigger): The user that last updated the schedule.\n* Schedule: (with manual trigger): The user who manually triggered the schedule to run the job.\n* Stream: The user who last updated the stream's repository/workspace attributes or enabled the stream.\n* Workspace App (no authentication required): The user that owns the security token that is used to run the job from the app.\n* Workspace App (authentication required): The user that authenticated to run the job through the app.\n* Automation App: The user that authenticated to run the job through the app.\n* Webhook URL: The user that owns the security token for the webhook URL.\n* Run Workspace with FMEFlowJobSubmitter transformer: The user account that authenticates the FME Flow connection in the transformer.\n* Data Virtualization (no authentication required): The user that owns the Data Virtualization API.\n* Data Virtualization (authentication required): The user that owns the security token that is used to call the Data Virtualization endpoint.","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"engineName","in":"query","description":"If specified, only jobs run by the specified engine will be returned. Queued jobs cannot be filtered by engine.","required":false,"schema":{"type":"string"}},{"name":"repository","in":"query","description":"If specified, only jobs from the specified repository will be returned.","required":false,"schema":{"type":"string"}},{"name":"workspace","in":"query","description":"If specified along with repository, only jobs from the specified repository and workspace will be returned.","required":false,"schema":{"type":"string"}},{"name":"sourceType","in":"query","description":"If specified, only jobs run by this source type will be returned.","required":false,"schema":{"$ref":"#/components/schemas/SourceType"}},{"name":"sourceID","in":"query","description":"","required":false,"schema":{"type":"string"}},{"name":"queue","in":"query","description":"If specified, only jobs routed through the specified queue will be returned.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, `workspace_asc` to sort by workspace in ascending order. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `timeFinished` in descending order by default.  Sorting is only supported on `workspace`, `timeFinished`, `timeStarted`, and `status`.","required":false,"schema":{"type":"string","default":""}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobPage"}}}}}},"post":{"tags":["jobs"],"summary":"Submit a job to be run","description":"Submits a job to be run. The ID of the running job is returned immediately, regardless of job status. The /jobs/{id}/result endpoint can be used to retrieve the job status. Each published parameter contains a `value` attribute that may contain either a list of items or a straightforward text value depending on the type of published parameter.  If published parameters are omitted, default values are provided by the workspace.  If any directives are omitted, the server assigns default values.","operationId":"runJob","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewJobRequest"}}},"required":true},"responses":{"202":{"description":"The job transformation was submitted successfully. The job ID is rendered in the response body.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobIDResponse"}}}}}}},"/jobs/{id}/cancel":{"post":{"tags":["jobs"],"summary":"Cancel a running or queued job","description":"Cancels the job and marks it as aborted in the completed jobs section, but does not remove it from the database. To completely remove a job, issue a second request to `DELETE /<job id>`.","operationId":"cancelJob","parameters":[{"name":"id","in":"path","description":"The ID of the job to cancel.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"}}}},"/jobrules":{"get":{"tags":["enginemanagement"],"summary":"Retrieve all job routing rules","description":"Retrieves all the job routing rules.","operationId":"getJobRules","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobRulePage"}}}}}},"post":{"tags":["enginemanagement"],"summary":"Create a job routing rule","description":"Creates a job routing rule.","operationId":"createJobRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewJobRuleRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/entraid":{"get":{"tags":["authentication services"],"summary":"Retrieve all Microsoft Entra (Azure AD) connections","operationId":"listConnections_1","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EntraIDPrimaryTenantPage"},{"$ref":"#/components/schemas/EntraIDSecondaryTenantPage"}]}}}}}},"post":{"tags":["authentication services"],"summary":"Add a Microsoft Entra (Azure AD) connection","operationId":"addConnection","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NewEntraIDPrimaryTenantRequest"},{"$ref":"#/components/schemas/NewEntraIDSecondaryTenantRequest"}]}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/entraid/{id}/synchronize":{"post":{"tags":["authentication services"],"summary":"Synchronize imported users and groups with a Microsoft Entra (Azure AD) directory","operationId":"synchronize_1","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/entraid/{id}/importuser":{"post":{"tags":["authentication services"],"summary":"Import a Microsoft Entra (Azure AD) user","operationId":"importUser_1","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportEntraIDUserRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/entraid/{id}/importrole":{"post":{"tags":["authentication services"],"summary":"Import a Microsoft Entra (Azure AD) security group","operationId":"importRole_1","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportEntraIDRoleRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImportRoleResponse"}}}}}}},"/enginerules":{"get":{"tags":["enginemanagement"],"summary":"Retrieve all engine assignment rules","description":"Retrieves all the engine assignment rules.","operationId":"getEngineRules","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EngineRulePage"}}}}}},"post":{"tags":["enginemanagement"],"summary":"Create an engine assignment rule","description":"Creates an engine assignment rule.","operationId":"createEngineRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewEngineRuleRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/enginerules/properties":{"get":{"tags":["enginemanagement"],"summary":"Retrieve all engine assignment rule properties","description":"Retrieves all the engine assignment properties.","operationId":"getEngineRuleProps","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}},"post":{"tags":["enginemanagement"],"summary":"Create an engine assignment rule property","description":"Creates an engine assignment rule property.","operationId":"createEngineRuleProp","requestBody":{"description":"Engine rule property","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewEngineRuleProp"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/enginehosts/{name}/engines/scale":{"post":{"tags":["deployment"],"summary":"Adjust number of FME Engines","description":"Adjusts number of FME Engines to the number specified in the request. FME Engines are started or stopped. For FME Flow deployed on a container orchestration system (for example Docker Compose or Kubernetes), it is recommended to use that system to scale up or down FME Engine containers.","operationId":"adjustEngines","parameters":[{"name":"name","in":"path","description":"Name of the engine host.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineScaleRequest"}}},"required":true},"responses":{"202":{"description":"The number of FME Engines are being adjusted to the specified number."}}}},"/deploymentparameters":{"get":{"tags":["deployment parameters"],"summary":"Retrieve deployment parameters","description":"Retrieves all deployment parameters on the FME Flow instance","operationId":"list_14","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only deployment parameters with matching names will be returned","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the filterString to the specified properties","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","owner"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeploymentParameterPage"}}}}}},"post":{"tags":["deployment parameters"],"summary":"Create a new deployment parameter","description":"Creates a new deployment parameter.    Deployment parameters support a subset of the FME JSON Parameters specification.   Here are examples of JSON requests to define the types that are currently supported.\n\n   **Text**\n   ```\n   {\n     \"name\": \"MyParam\",\n     \"value\": \"Example\",\n     \"type\": \"text\"\n   }\n   ```\n\n   **Database Connection**\n   ```\n   {\n     \"name\": \"MyParam\",\n     \"value\": \"Example\",\n     \"type\": \"dropdown\",\n     \"choiceSettings\": {\n       \"choiceSet\": \"dbConnections\",\n       \"family\": \"Example\"\n     }\n   }\n   ```\n\n   **Web Connection**\n   ```\n   {\n     \"name\": \"MyParam\",\n     \"value\": \"Example\",\n     \"type\": \"dropdown\",\n     \"choiceSettings\": {\n       \"choiceSet\": \"webConnections\",\n       \"services\": [\n         \"Example\"\n       ],\n       \"excludedServices\": [\n         \"Example\"\n       ]\n     }\n   }\n   ```\n\n   **Password**\n   ```\n   {\n     \"name\": \"MyParam\",\n     \"value\": \"Example\",\n     \"type\": \"password\"\n   }\n   ```\n","operationId":"create_5","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DeploymentParameterRequest"},{"$ref":"#/components/schemas/DeploymentParameterDropdown"},{"$ref":"#/components/schemas/DeploymentParameterPassword"},{"$ref":"#/components/schemas/DeploymentParameterText"}]}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/datavirtualization":{"get":{"tags":["data virtualization"],"summary":"Retrieve data virtualization APIs","operationId":"list_15","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"ownerID","in":"query","description":"APIs owned by the specified users will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"filterString","in":"query","description":"If specified, only APIs with a matching title or namespace will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataVirtualizationApiPage"}}}}}},"post":{"tags":["data virtualization"],"summary":"Create a new data virtualization API","operationId":"create_6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDataVirtualizationApiRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/datavirtualization/{apiID}/workspaces/download":{"post":{"tags":["data virtualization"],"summary":"Downloads multiple Data Virtualization Workspaces","operationId":"downloadWorkspaces","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadItemsRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/datavirtualization/{apiID}/tags":{"get":{"tags":["data virtualization"],"summary":"Retrieve tags for a data virtualization API","operationId":"list_16","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filterString","in":"query","description":"If specified, only tags with matching names will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataVirtualizationTagPage"}}}}}},"post":{"tags":["data virtualization"],"summary":"Create a new tag for a data virtualization API","operationId":"create_7","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataVirtualizationTagRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/datavirtualization/{apiID}/export":{"post":{"tags":["data virtualization"],"summary":"Creates OpenAPI JSON spec file for the specified data virtualization API","operationId":"exportOpenApiSpec","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}}}},"/datavirtualization/{apiID}/endpoints/{endpointID}/caching/purge":{"post":{"tags":["data virtualization"],"summary":"Purges the cache files and cache entries for a data virtualization API endpoint","operationId":"purgeCaching","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"endpointID","in":"path","description":"Specifies the UUID (unique identifier) of the endpoint","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/caching/purge":{"post":{"tags":["data virtualization"],"summary":"Purges the cache files and cache entries for a data virtualization API","operationId":"purgeCaching_1","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/import":{"post":{"tags":["data virtualization"],"summary":"Parses OpenAPI JSON spec to create an API and endpoints","operationId":"importOpenApiSpec","parameters":[{"name":"namespace","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["openApiSpecFile"],"type":"object","properties":{"openApiSpecFile":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Created"}}}},"/connections":{"get":{"tags":["connections"],"summary":"Retrieve connections","description":"Retrieve all database and web service connections","operationId":"getConnections_1","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"types","in":"query","description":"Connections belonging to the specified types will be returned.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"excludedTypes","in":"query","description":"Connections belonging to the specified types will be excluded, regardless of whether or not they are in 'types'.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"categories","in":"query","description":"Connections belonging to the specified categories will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["database","basic","token","oauthV2"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DatabaseConnectionPage"},{"$ref":"#/components/schemas/TokenConnectionPage"},{"$ref":"#/components/schemas/BasicConnectionPage"},{"$ref":"#/components/schemas/OAuthV2ConnectionPage"}]}}}}}},"post":{"tags":["connections"],"summary":"Create a new connection","operationId":"createConnection_2","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NewBasicConnectionRequest"},{"$ref":"#/components/schemas/NewDatabaseConnectionRequest"},{"$ref":"#/components/schemas/NewOAuthV2ConnectionRequest"},{"$ref":"#/components/schemas/NewTokenConnectionRequest"}]}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/configuration/systememail/test":{"post":{"tags":["configuration"],"summary":"Test system email properties","description":"Performs a test on the system email properties to see if the configuration is valid. If a password is provided, the system email test will use the provided password instead of the password stored in FME Flow. If a password is not provided, the system email test will use the password that is saved in the database (if available).","operationId":"testSystemEmailProps","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSystemEmailPropsRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestStatus"}}}}}}},"/configuration/encryption/generatekeyfile":{"post":{"tags":["configuration"],"summary":"Generate a new encryption key.","operationId":"generateKey","responses":{"204":{"description":"No Content"}}}},"/cleanup/tasks":{"get":{"tags":["cleanup"],"summary":"Retrieve all cleanup tasks","description":"Retrieve list of all cleanup tasks currently configured on FME Flow","operationId":"getTasks","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CleanupTaskPage"}}}}}},"post":{"tags":["cleanup"],"summary":"Create a cleanup task","description":"Creates a file delete task that deletes old files permanently from the file system","operationId":"createTask","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewCleanupTaskRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/cleanup/configuration/reset":{"post":{"tags":["cleanup"],"summary":"Resets configuration settings for FME Flow cleanup to system default values","operationId":"resetConfiguration","responses":{"204":{"description":"No Content"}}}},"/broadcast/messages":{"get":{"tags":["broadcast"],"summary":"Retrieve broadcast messages","description":"Retrieves broadcast messages. All users can retrieve enabled messages. Users with fmesuperuser role can retrieve all messages.","operationId":"listMessages","parameters":[{"name":"enabled","in":"query","description":"If true, only enabled messages are returned. If false, only disabled messages are returned. If not specified, all messages are returned.","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BroadcastMessagePage"}}}}}},"post":{"tags":["broadcast"],"summary":"Create a broadcast message","description":"Creates a broadcast message.","operationId":"createMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewBroadcastMessageRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/automations":{"get":{"tags":["automations"],"summary":"Retrieve automations","description":"Retrieves all automations","operationId":"getAutomations","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"enabled","in":"query","description":"If true, only enabled automations are returned. If false, only disabled automations are returned. If not specified, all automations are returned.","required":false,"schema":{"type":"boolean"}},{"name":"filterString","in":"query","description":"If specified, only automations with a matching name or owner will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","owner"]}}},{"name":"tags","in":"query","description":"Automations tagged with the specified tags will be returned.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AutomationPage"}}}}}},"post":{"tags":["automations"],"summary":"Create a new automation workflow","description":"Creates a new automation workflow.","operationId":"createAutomation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAutomationRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/automations/{id}/trigger":{"post":{"tags":["automations"],"summary":"Trigger the Manual node in an enabled automation workflow","description":"Triggers the Manual node in an enabled automation workflow.","operationId":"triggerManual","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the automation workflow","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The message with which to trigger the Manual node","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"202":{"description":"Success. The Manual node was triggered."}}}},"/automations/tags":{"get":{"tags":["automations"],"summary":"Retrieve automation tags","operationId":"list_18","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only tags with matching names will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TagPage"}}}}}},"post":{"tags":["automations"],"summary":"Create a new automation tag","operationId":"create_8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/activeperiods":{"get":{"tags":["enginemanagement"],"summary":"Retrieve all active periods","description":"Retrieves all the active periods.","operationId":"getActivePeriods","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivePeriodPage"}}}}}},"post":{"tags":["enginemanagement"],"summary":"Create an active period","description":"Creates an active period.","operationId":"createActivePeriod","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewActivePeriodRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/accounts":{"get":{"tags":["security"],"summary":"Retrieve accounts","description":"Retrieve all accounts","operationId":"getAccounts","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"summary","in":"query","description":"If `true`, account summaries are returned. Summaries exclude sensitive information such as roles and password metadata. Password metadata includes whether or not the password has expired or needs to be changed. Default is `true`.","required":false,"schema":{"type":"boolean","default":true}},{"name":"originID","in":"query","description":"If specified, only accounts imported from this Authentication Service will be returned. When using this parameter, `type` also needs to be specified. Currently only LDAP and Azure Active Directory are supported. For accounts imported from Azure AD, the tenant ID will need to be specified.","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"filterString","in":"query","description":"If specified, only accounts with matching usernames, full names or emails will be returned. If the `summary` parameter is `false`, then accounts with matching roles will also be returned. \n\nNote: All other query parameters applied to this request will be used in conjunction with the `filterString` parameter.","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"If specified, only accounts with matching type will be returned.","required":false,"schema":{"type":"string","enum":["system","ldap","azure","saml"]}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","fullname","email","role"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountPage"}}}}}},"post":{"tags":["security"],"summary":"Create a new account","description":"Creates a new account","operationId":"createAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewAccountRequest"}}},"required":true},"responses":{"201":{"description":"Created"}}}},"/workspaces":{"get":{"tags":["repositories"],"summary":"Retrieve summaries of workspaces","description":"Retrieve summaries of all workspaces","operationId":"getWorkspaceSummaries","parameters":[{"name":"repository","in":"query","description":"If specified, only workspaces in the specified repository will be returned.","required":false,"schema":{"type":"string"}},{"name":"filterString","in":"query","description":"If specified, only workspaces with matching name or title will be returned. \n\nNote: All other query parameters applied to this request will be used in conjunction with the `filterString` parameter.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemSummaryPage"}}}}}}},"/workspaces/{repository}/{workspace}":{"get":{"tags":["repositories"],"summary":"Retrieve information about a workspace","description":"Retrieves information about a workspace","operationId":"getWorkspace","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}}}},"delete":{"tags":["repositories"],"summary":"Delete a workspace","description":"Deletes a workspace","operationId":"deleteWorkspace","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/workspaces/{repository}/{workspace}/resources/{resource}":{"get":{"tags":["repositories"],"summary":"Retrieve a resource","description":"Retrieves a resource for a workspace","operationId":"getWorkspaceResource","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}},{"name":"resource","in":"path","description":"Name of the resource","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Resource"}}}}}},"delete":{"tags":["repositories"],"summary":"Delete a resource","description":"Deletes a resource","operationId":"deleteWorkspace_1","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}},{"name":"resource","in":"path","description":"Name of the resource","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/workspaces/{repository}/{workspace}/resources/{resource}/download":{"get":{"tags":["repositories"],"summary":"Download a resource file","description":"Downloads a resource file.","operationId":"downloadWorkspace","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}},{"name":"resource","in":"path","description":"Name of the resource","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/workspaces/{repository}/{workspace}/parameters":{"get":{"tags":["repositories"],"summary":"Retrieve workspace parameters","description":"Retrieve all workspace parameters","operationId":"getParameters","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}}}}}}}},"/workspaces/{repository}/{workspace}/download":{"get":{"tags":["repositories"],"summary":"Download a workspace file","description":"Downloads a workspace file. This web page will only display the response body automatically, and include the option to download the file above the header.","operationId":"downloadWorkspace_1","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"pattern":".*.(?i)fmw","type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/tokens/{id}/items/{category}/{item}":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for a security item","description":"Retrieves permissions for a security item for the user token","operationId":"getSingleItemPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionResponse"}}}}}}},"/tokens/{id}/categories/{category}":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for a security category","description":"Retrieves permissions for a security category for the token","operationId":"getSingleCategoryPermissions","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryPermissionResponse"}}}}}}},"/systemevents/events":{"get":{"tags":["configuration"],"summary":"Retrieve completed system events","description":"Retrieves all completed system events.","operationId":"listEventsHistory","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"type","in":"query","description":"If specified, only system events of the specified type will be returned.","required":false,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Specifies the start date time. If specified, the list of completed system events will be fetched from start until now unless end is provided.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-01-01T00:00:00.000Z"},{"name":"end","in":"query","description":"Specifies the end date time.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-12-31T11:59:59.999Z"}],"responses":{"200":{"description":"The list of completed system events is rendered in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemEventsHistoryPage"}}}}}}},"/systemevents/configurations":{"get":{"tags":["configuration"],"summary":"Retrieve system event configurations","description":"Retrieves all system event configurations","operationId":"listConfigurations","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemEventsConfigurationPage"}}}}}}},"/streams/{id}/engines":{"get":{"tags":["streams"],"summary":"Retrieve engines","description":"Retrieves all engines assigned to a stream","operationId":"list_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnginePage"}}}}}}},"/streams/assignableengines":{"get":{"tags":["streams"],"summary":"Retrieve engines","description":"Retrieves all engines that can be assigned to a stream (i.e. engines that are connected and not currently assigned to a stream)","operationId":"list_2","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnginePage"}}}}}}},"/roles/{id}/items/{category}/{item}":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for a security item","description":"Retrieves permissions for a security item for the role","operationId":"getSingleItemPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionResponse"}}}}}}},"/roles/{id}/categories/{category}":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for a security category","description":"Retrieves permissions for a security category for the role","operationId":"getSingleCategoryPermissions_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryPermissionResponse"}}}}}}},"/resources/types/enabled":{"get":{"tags":["resources"],"summary":"Retrieve all enabled resource types","description":"Retrieves all resource types that are enabled and supported by this API.","operationId":"getEnabledTypes","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string","enum":["file","awsS3","network"]}}}}}}}},"/resources/connections/{connection}/info":{"get":{"tags":["resources"],"summary":"Retrieve file or directory metadata","description":"Retrieves metadata for a directory or regular file.","operationId":"getMetadata","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Path, relative to the resource connection (for example, /foo/bar/test.file).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SharedResourceFileInfoResponse"}}}}}}},"/repositories/{repository}/items":{"get":{"tags":["repositories"],"summary":"Retrieve summaries of repository items","description":"Retrieve summaries of all repository items","operationId":"getRepositoryItemSummaries","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"type","in":"query","description":"If specified, only repository items of the specified type will be returned.","required":false,"schema":{"type":"string","enum":["workspace","customFormat","customTransformer","template"]}},{"name":"filterString","in":"query","description":"If specified, only repository items with matching name or title will be returned. \n\nNote: All other query parameters applied to this request will be used in conjunction with the `filterString` parameter.","required":false,"schema":{"type":"string"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","title"]}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemSummaryPage"}}}}}}},"/repositories/{repository}/items/{item}":{"get":{"tags":["repositories"],"summary":"Retrieve information about a repository item","description":"Retrieves information about a repository item","operationId":"getRepositoryItem","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WorkspaceResponse"},{"$ref":"#/components/schemas/NonWorkspaceItemResponse"}]}}}}}},"delete":{"tags":["repositories"],"summary":"Delete a repository item","description":"Deletes a repository item","operationId":"deleteRepositoryItem","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/repositories/{repository}/items/{item}/resources/{resource}":{"get":{"tags":["repositories"],"summary":"Retrieve a resource","description":"Retrieves a resource for a repository item","operationId":"getRepositoryItemResource","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}},{"name":"resource","in":"path","description":"Name of the resource","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Resource"}}}}}},"delete":{"tags":["repositories"],"summary":"Delete a resource","description":"Deletes a resource","operationId":"deleteRepositoryItem_1","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}},{"name":"resource","in":"path","description":"Name of the resource","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/repositories/{repository}/items/{item}/resources/{resource}/download":{"get":{"tags":["repositories"],"summary":"Download a resource file","description":"Downloads a resource file.","operationId":"downloadRepositoryItem","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}},{"name":"resource","in":"path","description":"Name of the resource","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/repositories/{repository}/items/{item}/download":{"get":{"tags":["repositories"],"summary":"Download a repository item file","description":"Downloads a repository item file. This web page will only display the response body automatically, and include the option to download the file above the header.","operationId":"downloadRepositoryItem_1","parameters":[{"name":"repository","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Name of the item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/remoteengines/{id}/engines":{"get":{"tags":["remote engines"],"summary":"Retrieve all engines","description":"Retrieves all engines for the specified remote engine.","operationId":"list_4","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"type","in":"query","description":"If specified, only engines of this type will be returned.","required":false,"schema":{"type":"string","enum":["standard","dynamic"]}},{"name":"state","in":"query","description":"If specified, only engines with this state will be returned.","required":false,"schema":{"type":"string","enum":["idle","runningJob","disconnected"]}},{"name":"summary","in":"query","description":"If `true`, engine summaries are returned. Summaries exclude info such as assigned queues. Default is `true`.","required":false,"schema":{"type":"boolean","default":true}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, `name_asc` to sort by name in ascending order. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `name` in ascending order by default. Sorting is only supported for `name`.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnginePage"}}}}}}},"/remoteengines/streams/{id}/engines":{"get":{"tags":["remote engines"],"summary":"Retrieves engines for the stream. By default, only assigned engines are returned when no filter is specified.","description":"Retrieves engines for the stream. By default, only assigned engines are returned when no filter is specified.","operationId":"getEngines","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the stream","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filter","in":"query","description":"If specified, only engines of this type will be returned.","required":false,"schema":{"type":"string","description":"Engine filter options for stream","default":"assigned","enum":["assigned","assignable","all"]}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnginePage"}}}}}}},"/projects/tasks":{"get":{"tags":["projects"],"summary":"Retrieve all project export and import tasks.","operationId":"list_7","parameters":[{"name":"type","in":"query","description":"If specified, only tasks with one of the given types will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["projectImport","projectExport"]}}},{"name":"excludePending","in":"query","description":"If specified, only tasks that have completed will be listed","required":false,"schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only tasks with matching owner name or task ID will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectTasksPage"}}}}}}},"/projects/tasks/{id}":{"get":{"tags":["projects"],"summary":"Retrieve a project export or import task","operationId":"get_3","parameters":[{"name":"id","in":"path","description":"ID of the task","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectTaskResponse"}}}}}}},"/projects/tasks/{id}/log/parsed":{"get":{"tags":["projects"],"summary":"Retrieve the project export or import task log file parsed as JSON","operationId":"getMigrationLogParsed","parameters":[{"name":"id","in":"path","description":"The ID of the task","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only show lines containing the specified string.","required":false,"schema":{"type":"string"}},{"name":"error","in":"query","description":"Filter by errors.","required":false,"schema":{"type":"boolean","default":false}},{"name":"warn","in":"query","description":"Filter by warnings.","required":false,"schema":{"type":"boolean","default":false}},{"name":"inform","in":"query","description":"Filter by information.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, use `time_asc` to sort by earliest logs first, and use `time_desc` to sort by latest log lines first. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `time` in ascending order by default. Sorting is only supported on `time`.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrationLogLinePage"}}}}}}},"/projects/imports":{"get":{"tags":["projects"],"summary":"Gets all imports","description":"Returns a list of all the imports","operationId":"list_8","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"statuses","in":"query","description":"If specified, only imports with one of the given statuses will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["generatingPreview","ready","importing","imported","failed"]}}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImportPage"}}}}}}},"/projects/imports/{id}/project":{"get":{"tags":["projects"],"summary":"Gets the primary project of an import","description":"Gets the primary or top-level project of an import","operationId":"get_5","parameters":[{"name":"id","in":"path","description":"Specifies the ID of a migration task","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImportItemResponse"}}}}}}},"/projects/imports/{id}/items":{"get":{"tags":["projects"],"summary":"Gets items from an import","description":"Gets the items from an import that has been run or has a generated preview","operationId":"list_9","parameters":[{"name":"id","in":"path","description":"Specifies the ID of a migration task","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"type","in":"query","description":"If specified, only import items with one of the specified types will be returned.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImportItemType"}}},{"name":"previewActions","in":"query","description":"If specified, only import items with one of the specified preview actions will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["unknown","created","overwritten","skipped","failed"]}}},{"name":"filterString","in":"query","description":"If specified, only import items with matching name or ID will be returned.","required":false,"schema":{"type":"string"}},{"name":"exists","in":"query","description":"If specified, only items that exist or do not exist on this Flow instance will be returned.","required":false,"schema":{"type":"boolean"}},{"name":"source","in":"query","description":"If specified, only items are from the given source will be returned.","required":false,"schema":{"type":"string","enum":["project","dependency"]}},{"name":"selectable","in":"query","description":"If true, only items of selectable types will be returned, otherwise non-selectable.","required":false,"schema":{"type":"boolean"}},{"name":"filterProperties","in":"query","description":"If specified, only applies the `filterString` to the specified properties.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["name","id"]}}},{"name":"ownerMissing","in":"query","description":"If true, only items that are missing an owner will be returned. Note that only items that can have an owner are returned. A value of false is not accepted.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ImportItemsPage"}}}}}}},"/projects/imports/{id}/items/test":{"get":{"tags":["projects"],"summary":"Test import items","description":"Test validity of all items belonging to the specified import","operationId":"test_3","parameters":[{"name":"id","in":"path","description":"Specifies the ID of a migration task","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"},"207":{"description":"The response body contains information about the result of the test operation, indicating success or error status for each operation."}}}},"/permissions/metadata/items":{"get":{"tags":["permissions"],"summary":"Retrieve available item permissions","description":"Retrieves available item permissions","operationId":"getSystemItemPermissions","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionMetadataResponse"}}}}}}}},"/permissions/metadata/categories":{"get":{"tags":["permissions"],"summary":"Retrieve available category permissions","description":"Retrieves available category permissions","operationId":"getAvailableCategoryPermissions","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PermissionMetadataResponse"}}}}}}}},"/permissions/items":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for security items","description":"Retrieves permissions for security items","operationId":"getItems","parameters":[{"name":"category","in":"query","description":"Category of the security item","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only items with a matching name, owner, allowed users, or allowed roles will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionsPage"}}}}}}},"/packages/{id}":{"get":{"tags":["packages"],"summary":"Retrieve an individual package","description":"Retrieves an individual package by its unique identifier.","operationId":"get_6","parameters":[{"name":"id","in":"path","description":"Specifies the id of the package (publisherUID.uid)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PackageResponse"}}}}}},"delete":{"tags":["packages"],"summary":"Delete a package","description":"Deletes a package given a unique identifier. Note that this operation removes references to the package and deletes the .fpkg file from the Engine shared resource, but does not uninstall the package from any FME Engines where it is installed.","operationId":"delete_4","parameters":[{"name":"id","in":"path","description":"Specifies the id of the package (publisherUID.uid)","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/migrations/tasks":{"get":{"tags":["migrations"],"summary":"Retrieve all system backup and restore tasks.","operationId":"list_11","parameters":[{"name":"type","in":"query","description":"If specified, only tasks with one of the given types will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["systemRestore","systemBackup"]}}},{"name":"status","in":"query","description":"If specified, only tasks with one of the given statuses will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["submitted","running","success","failure"]}}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only tasks with matching owner name or task ID will be returned.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrationTasksPage"}}}}}}},"/migrations/tasks/{id}":{"get":{"tags":["migrations"],"summary":"Retrieve a system backup or restore task","operationId":"get_7","parameters":[{"name":"id","in":"path","description":"ID of the task","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrationTaskResponse"}}}}}}},"/migrations/tasks/{id}/log":{"get":{"tags":["migrations"],"summary":"Retrieve the system backup or restore task log file","operationId":"getMigrationLog","parameters":[{"name":"id","in":"path","description":"The ID of the task","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}},"/migrations/tasks/{id}/log/parsed":{"get":{"tags":["migrations"],"summary":"Retrieve the system backup or restore task log file parsed as JSON","operationId":"getMigrationLogParsed_1","parameters":[{"name":"id","in":"path","description":"The ID of the task","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only show lines containing the specified string.","required":false,"schema":{"type":"string"}},{"name":"error","in":"query","description":"Filter by errors.","required":false,"schema":{"type":"boolean","default":false}},{"name":"warn","in":"query","description":"Filter by warnings.","required":false,"schema":{"type":"boolean","default":false}},{"name":"inform","in":"query","description":"Filter by information.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, use `time_asc` to sort by earliest logs first, and use `time_desc` to sort by latest log lines first. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `time` in ascending order by default. Sorting is only supported on `time`.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrationLogLinePage"}}}}}}},"/metrics":{"get":{"tags":["metrics"],"summary":"Retrieves FME Flow metrics in Prometheus/OpenMetric format.","description":"Metrics returned are the number of queued jobs per job queue (job routing tag), number of running jobs per job queue (job routing tag), total number of queued jobs, total number of running jobs, total number of completed jobs.","operationId":"getJobMetrics","responses":{"200":{"description":"OK","content":{"application/openmetrics-text":{"schema":{"type":"object"}},"application/json":{"schema":{"type":"object"}}}}}}},"/metrics/jobs":{"get":{"tags":["metrics"],"summary":"Retrieve average job metrics within specified start and end date time","description":"Retrieves average job metrics within specified start and end date time.","operationId":"getJobMetricsAvg","parameters":[{"name":"start","in":"query","description":"Specifies the start date time.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2022-01-01T00:00:00.000Z"},{"name":"end","in":"query","description":"Specifies the end date time.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2022-12-31T11:59:59.999Z"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobMetricsAvgResponse"}}}}}}},"/metrics/jobcount":{"get":{"tags":["metrics"],"summary":"Retrieve job counts for each interval within specified start and end date time","description":"Retrieves job counts for each interval within specified start and end date time. Only completed jobs are included in the count.","operationId":"getJobCount","parameters":[{"name":"start","in":"query","description":"Specifies the start date time.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2022-01-01T00:00:00.000Z"},{"name":"end","in":"query","description":"Specifies the end date time.","required":true,"schema":{"type":"string","format":"date-time"},"example":"2022-12-31T11:59:59.999Z"},{"name":"interval","in":"query","description":"Specifies the job count interval to return.","required":true,"schema":{"type":"string","enum":["second","minute","hour","day","month","year"]}},{"name":"type","in":"query","description":"Specifies the type of job count interval to return.","required":true,"schema":{"type":"string","enum":["submitted","started","finished","overlap"]}},{"name":"queue","in":"query","description":"If specified, only job count intervals for the specified queue are returned.","required":false,"schema":{"type":"string"}},{"name":"engine","in":"query","description":"If specified, only job count intervals for the specified engine are returned.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return.","required":false,"schema":{"maximum":5000,"minimum":0,"type":"integer","format":"int64","default":100}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobCountIntervalPage"}}}}}}},"/license/status":{"get":{"tags":["licensing"],"summary":"Retrieve status of installed FME Flow license","description":"Retrieves status of the installed FME Flow license.","operationId":"getLicenseStatus","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseStatusResponse"}}}}}}},"/license/request/status":{"get":{"tags":["licensing"],"summary":"Retrieve status of license file installation","description":"Retrieves the status of a license file installation.","operationId":"getRequestLicenseStatus","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseRequestStatusResponse"}}}}}}},"/license/refresh/status":{"get":{"tags":["licensing"],"summary":"Retrieve status of license file refresh","description":"Retrieves the status of a license file refresh.","operationId":"getRefreshLicenseStatus","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseRequestStatusResponse"}}}}}}},"/license/machinekey":{"get":{"tags":["licensing"],"summary":"Retrieve machine key","description":"Retrieves machine key of the machine running FME Flow.","operationId":"getMachineKey","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MachineKeyResponse"}}}}}}},"/ldap/{id}/users":{"get":{"tags":["authentication services"],"summary":"Retrieve all LDAP users","operationId":"getUsers","parameters":[{"name":"id","in":"path","description":"ID of the LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filter","in":"query","description":"Filter to retrieve LDAP roles.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}}},"/ldap/{id}/user":{"get":{"tags":["authentication services"],"summary":"Retrieve an LDAP user","operationId":"getUser","parameters":[{"name":"id","in":"path","description":"ID of the LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"distinguishedName","in":"query","description":"Distinguished name of the LDAP user.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"/ldap/{id}/roles":{"get":{"tags":["authentication services"],"summary":"Retrieve all LDAP roles","operationId":"getRoles_2","parameters":[{"name":"id","in":"path","description":"ID of the LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filter","in":"query","description":"Filter to retrieve LDAP roles.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LDAPRoleResponse"}}}}}}}},"/ldap/{id}/role":{"get":{"tags":["authentication services"],"summary":"Retrieve an LDAP role","operationId":"getRole_1","parameters":[{"name":"id","in":"path","description":"ID of the LDAP server.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"distinguishedName","in":"query","description":"Distinguished name of the LDAP role.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LDAPRoleResponse"}}}}}}},"/jobs/{id}":{"get":{"tags":["jobs"],"summary":"Retrieve the job record according to the specified ID","description":"Given an ID, this retrieves the record for a job, regardless of whether it is queued, running or completed.","operationId":"getJob","parameters":[{"name":"id","in":"path","description":"The ID of the job to return.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}}}},"delete":{"tags":["jobs"],"summary":"Remove a completed job","description":"Removes the job record from the database.","operationId":"deleteJob","parameters":[{"name":"id","in":"path","description":"The ID of the job to remove.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"}}}},"/jobs/{id}/result":{"get":{"tags":["jobs"],"summary":"Retrieve a job's result","description":"Given a job ID, retrieves the associated job result.","operationId":"getJobResult","parameters":[{"name":"id","in":"path","description":"The ID of the job to return.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"longPoll","in":"query","description":"If true, the request will wait until the job is complete or the long poll interval times out.","required":false,"schema":{"type":"boolean","default":false}},{"name":"longPollInterval","in":"query","description":"If specified and longPoll is enabled, the long poll interval determines how long to wait in seconds before terminating the request. The minimum long poll interval is 1 second and the maximum long poll interval is 1 day (in seconds). If longPoll is enabled and no longPollInterval is specified, the default of 45 seconds is used.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobResultResponse"}}}},"202":{"description":"The job result was not retrieved within the timeout period. The job ID is rendered in the response body.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobIDResponse"}}}}}}},"/jobs/{id}/log":{"get":{"tags":["jobs"],"summary":"Retrieve job log","description":"Downloads or retrieves in plain text the log file of a job.","operationId":"getJobLog","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The ID of the job.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}},"/jobs/{id}/log/parsed":{"get":{"tags":["jobs"],"summary":"Retrieve parsed job log","description":"Retrieves the log file of a job parsed as JSON.","operationId":"getJobLogParsed","parameters":[{"name":"id","in":"path","description":"The ID of the job.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"filterString","in":"query","description":"If specified, only show lines containing the specified string.","required":false,"schema":{"type":"string"}},{"name":"error","in":"query","description":"Filter by errors.","required":false,"schema":{"type":"boolean","default":false}},{"name":"warn","in":"query","description":"Filter by warnings.","required":false,"schema":{"type":"boolean","default":false}},{"name":"inform","in":"query","description":"Filter by information.","required":false,"schema":{"type":"boolean","default":false}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, use `time_asc` to sort by earliest logs first, and use `time_desc` to sort by latest log lines first. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `time` in ascending order by default. Sorting is only supported on `time`.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobLogLinePage"}}}}}}},"/healthcheck/readiness":{"get":{"tags":["healthcheck"],"summary":"Retrieve readiness status of FME Flow","description":"Indicates the readiness status of FME Flow. The system is \"ready\" if it is able to process jobs.","operationId":"getReadiness","parameters":[{"name":"includeDetails","in":"query","description":"If true, the health status of each component will be included in the response.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HealthCheckResponse"}}}}}}},"/healthcheck/liveness":{"get":{"tags":["healthcheck"],"summary":"Retrieve liveness status of FME Flow","description":"Indicates the liveness status of FME Flow. The system is \"live\" if the essential processes are responsive. A system may be \"live\" yet unable to process jobs.","operationId":"getLiveness","parameters":[{"name":"includeDetails","in":"query","description":"If true, the health status of each component will be included in the response.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HealthCheckResponse"}}}}}}},"/entraid/{id}/users":{"get":{"tags":["authentication services"],"summary":"Search a Microsoft Entra (Azure AD) directory for users","operationId":"getUsers_1","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"query","in":"query","description":"Search parameter to query Microsoft Entra (Azure AD) users by.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserPage"}}}}}}},"/entraid/{id}/user":{"get":{"tags":["authentication services"],"summary":"Retrieve user from a Microsoft Entra (Azure AD) connection","operationId":"getUser_1","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"userID","in":"query","description":"The object id of the Microsoft Entra (Azure AD) user.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntraIDUserResponse"}}}}}}},"/entraid/{id}/roles":{"get":{"tags":["authentication services"],"summary":"Search directory for security groups on a Microsoft Entra (Azure AD) connection","operationId":"getRoles_3","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"query","in":"query","description":"Search parameter to query Microsoft Entra (Azure AD) security groups by.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntraIDRolePage"}}}}}}},"/entraid/{id}/role":{"get":{"tags":["authentication services"],"summary":"Retrieve security group from the Microsoft Entra (Azure AD) connection","operationId":"getRole_2","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"roleID","in":"query","description":"The object id of the Microsoft Entra (Azure AD) group.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntraIDRoleResponse"}}}}}}},"/entraid/{id}/role/members":{"get":{"tags":["authentication services"],"summary":"Retrieve members of a security group from a Microsoft Entra (Azure AD) connection","operationId":"getRoleMembers","parameters":[{"name":"id","in":"path","description":"The tenant ID for the Microsoft Entra (Azure AD) connection.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"roleID","in":"query","description":"The object id of the Microsoft Entra (Azure AD) group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserPage"}}}}}}},"/engines":{"get":{"tags":["engines"],"summary":"Retrieve engines","description":"Retrieves all engines registered with FME Flow","operationId":"list_12","parameters":[{"name":"type","in":"query","description":"If specified, only engines of this type will be returned.","required":false,"schema":{"type":"string","enum":["standard","dynamic"]}},{"name":"state","in":"query","description":"If specified, only engines with this state will be returned.","required":false,"schema":{"type":"string","enum":["idle","runningJob","disconnected"]}},{"name":"summary","in":"query","description":"If `true`, engine summaries are returned. Summaries exclude info such as assigned queues. Default is `true`.","required":false,"schema":{"type":"boolean","default":true}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}},{"name":"sort","in":"query","description":"Specifies the sort order of the result. Append `_asc` to the property name to sort in ascending order or `_desc` to sort in descending order. For example, `name_asc` to sort by name in ascending order. If the suffix is unspecified, the property will be sorted in ascending order. If no sorting parameter is specified, the result will be sorted by `name` in ascending order by default. Sorting is only supported for `name`.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DetailedEnginePage"}}}}}}},"/enginehosts":{"get":{"tags":["deployment"],"summary":"Retrieve FME Engine hosts","description":"Retrieves all hosts configured to run FME Engines. ","operationId":"list_13","parameters":[{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EngineHostPage"}}}}}}},"/enginehosts/{name}/engines":{"get":{"tags":["deployment"],"summary":"Retrieve configured FME Engines","description":"Retrieves all FME Engines configured to run on the specified FME Engine host. ","operationId":"getEngines_1","parameters":[{"name":"name","in":"path","description":"Name of the engine host.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EngineProcessInfoResponse"}}}}}}}},"/dependencies":{"get":{"tags":["dependencies"],"summary":"Retrieve dependencies of a item","description":"Retrieves all dependencies of a item","operationId":"get_9","parameters":[{"name":"id","in":"query","description":"Unique ID of the resource","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of the resource","required":true,"schema":{"$ref":"#/components/schemas/DependencyItemType"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DependencyResponse"}}}}}}}},"/datavirtualization/{apiID}/workspaces":{"get":{"tags":["data virtualization"],"summary":"Retrieve workspaces associated with a Data Virtualization API","operationId":"listWorkspaces","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filterString","in":"query","description":"If specified, only workspaces matching the search query will be returned.","required":false,"schema":{"type":"string"}},{"name":"isUsed","in":"query","description":"If true, only workspaces that are currently associated with endpoints will be returned","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataVirtualizationWorkspacePage"}}}}}}},"/datavirtualization/{apiID}/workspaces/{workspace}/download":{"get":{"tags":["data virtualization"],"summary":"Downloads the specified Data Virtualization Workspace","operationId":"downloadWorkspace_2","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/datavirtualization/{apiID}/schemas":{"get":{"tags":["data virtualization"],"summary":"Get all Schemas","operationId":"getSchemaList","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization schema","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataVirtualizationSchemaPage"}}}}}}},"/datavirtualization/{apiID}/endpoints":{"get":{"tags":["data virtualization"],"summary":"Retrieve endpoints for a data virtualization API","operationId":"list_17","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filterString","in":"query","description":"If specified, only endpoints matching the search query will be returned.","required":false,"schema":{"type":"string"}},{"name":"operation","in":"query","description":"If specified, only endpoints that have any of the operations will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["get","post","put","delete"]}}},{"name":"inheritSecurity","in":"query","description":"If specified, only endpoints matching the provided inheritSecurity value will be returned.","required":false,"schema":{"type":"boolean"}},{"name":"requireAuthentication","in":"query","description":"If specified, only endpoints matching the provided requireAuthentication value will be returned.","required":false,"schema":{"type":"boolean"}},{"name":"allowedRoles","in":"query","description":"If specified, only endpoints that have any of the allowedRoles will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"allowedUsers","in":"query","description":"If specified, only endpoints that have any of the allowedUsers will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"responseType","in":"query","description":"If specified, only endpoints that match the provided responseType will be returned.","required":false,"schema":{"type":"string","enum":["workspace","manual"]}},{"name":"workspace","in":"query","description":"If specified, only endpoints assigned to the provided workspace will be returned.","required":false,"schema":{"type":"string"}},{"name":"workspaceStatus","in":"query","description":"If specified, only endpoints that match any of the provided workspaceStatuses will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["unassigned","needsAuthoring","needsUpdating","assigned"]}}},{"name":"tags","in":"query","description":"If specified, only endpoints that have any of the provided tags will be returned.","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"asyncEnabled","in":"query","description":"If specified, only endpoints matching the provided asyncEnabled value will be returned.","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","description":"Specifies the maximum number of results to return, which is useful for iterative results paging. The limit can be any number between 0 to 1000 inclusive.","required":false,"schema":{"maximum":1000,"minimum":0,"type":"integer","format":"int64","default":100}},{"name":"offset","in":"query","description":"Specifies the offset to start the result, which is useful for iterative results paging. An offset of 0 will return results starting from the first entry. The offset can be any number greater than or equal to 0.","required":false,"schema":{"minimum":0,"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DataVirtualizationEndpointPage"}}}}}}},"/configuration/topicmonitoring":{"get":{"tags":["configuration"],"summary":"Retrieve the configuration of all topic monitoring poperties.","operationId":"getAllTopicMonitoringConfig","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TopicMonitoringResponse"}}}}}}},"/configuration/encryption":{"get":{"tags":["configuration"],"summary":"Retrieve the encryption configuration","operationId":"getEncryptionConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EncryptionConfigResponse"}}}}}}},"/cleanup/system":{"get":{"tags":["cleanup"],"summary":"Retrieve all system scheduled cleanup tasks","operationId":"getTasks_1","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CleanupSystemTaskPage"}}}}}}},"/accounts/{id}/items/{category}/{item}":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for a security item","description":"Retrieves permissions for a security item for the user account","operationId":"getSingleItemPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ItemPermissionResponse"}}}}}}},"/accounts/{id}/categories/{category}":{"get":{"tags":["permissions"],"summary":"Retrieve permissions for a security category","description":"Retrieves permissions for a security category for the user account","operationId":"getSingleCategoryPermissions_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoryPermissionResponse"}}}}}}},"/tokens/{id}/items/{category}/{item}/permissions/{permission}":{"delete":{"tags":["permissions"],"summary":"Revoke one permission for a security item","description":"Revokes one permission for a security item for the user token.","operationId":"revokeSingleItemPermission","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}},{"name":"permission","in":"path","description":"Security permission","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/tokens/{id}/categories/{category}/permissions/{permission}":{"delete":{"tags":["permissions"],"summary":"Revoke one permission for a security category","description":"Revokes one permission for a security category for the token.","operationId":"revokeSingleCategoryPermission","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the token","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"permission","in":"path","description":"Security permission","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/roles/{id}/items/{category}/{item}/permissions/{permission}":{"delete":{"tags":["permissions"],"summary":"Revoke one permission for a security item","description":"Revokes one permission for a security item for the role.","operationId":"revokeSingleItemPermission_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}},{"name":"permission","in":"path","description":"Security permission","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/roles/{id}/categories/{category}/permissions/{permission}":{"delete":{"tags":["permissions"],"summary":"Revoke one permission for a security category","description":"Revokes one permission for a security category for the role.","operationId":"revokeSingleCategoryPermission_1","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"permission","in":"path","description":"Security permission","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/roles/{id}/accounts/{accountID}":{"delete":{"tags":["security"],"summary":"Remove an account assignment from a role","description":"Removes the assignment of an account from a role.","operationId":"deleteAccount","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the role","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"accountID","in":"path","description":"Specifies the UUID (unique identifier) of the account to remove from the role.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/resources/connections/{connection}/item":{"delete":{"tags":["resources"],"summary":"Remove a file or directory","description":"Removes a file or directory from the resource connection.","operationId":"remove","parameters":[{"name":"connection","in":"path","description":"Name of a resource connection.","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Path, relative to the resource connection (for example, /foo/bar/test.file).","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/remoteengines/{id}/cache":{"delete":{"tags":["remote engines"],"summary":"Deletes cache for specified Remote Engine connection","description":"Deletes cache for specified Remote Engine connection","operationId":"deleteCache","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the Remote Engine connection","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/remoteengines/cache":{"delete":{"tags":["remote engines"],"summary":"Deletes cache for all Remote Engine connections","description":"Deletes cache for all Remote Engine connections","operationId":"deleteCache_1","responses":{"204":{"description":"No Content"}}}},"/projects/{id}/deleteall":{"delete":{"tags":["projects"],"summary":"Delete a project and contents","description":"Delete a project and its contents given the ID","operationId":"deleteProjectAll","parameters":[{"name":"id","in":"path","description":"UUID of the project","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deleteDependencies","in":"query","description":"If true, also delete any resources that are dependencies of project items.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"No Content"}}}},"/enginerules/properties/{name}":{"delete":{"tags":["enginemanagement"],"summary":"Delete an engine assignment rule property","description":"Deletes an existing engine assignment rule property.","operationId":"deleteEngineRule_1","parameters":[{"name":"name","in":"path","description":"Name of the engine assignment rule property.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/enginehosts/{name}":{"delete":{"tags":["deployment"],"summary":"Remove a FME Engine host","description":"Removes a FME Engine host from FME Flow. ","operationId":"removeEngineHost","parameters":[{"name":"name","in":"path","description":"Name of the engine host.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/workspaces/{workspace}":{"delete":{"tags":["data virtualization"],"summary":"Delete the specified Data Virtualization Workspace","operationId":"deleteWorkspace_2","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"workspace","in":"path","description":"Name of the workspace","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/schemas/{schemaID}":{"delete":{"tags":["data virtualization"],"summary":"Delete a Schema","operationId":"deleteSchema","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"schemaID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization schema","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/datavirtualization/{apiID}/endpoints/{endpointID}":{"delete":{"tags":["data virtualization"],"summary":"Delete a data virtualization API endpoint","operationId":"delete_8","parameters":[{"name":"apiID","in":"path","description":"Specifies the UUID (unique identifier) of the data virtualization API","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"endpointID","in":"path","description":"Specifies the UUID (unique identifier) of the endpoint","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/roles/{roleID}":{"delete":{"tags":["security"],"summary":"Remove a role assignment from an account","description":"Removes the assignment of a role from an account.","operationId":"deleteRole_1","parameters":[{"name":"id","in":"path","description":"Specifies the UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"roleID","in":"path","description":"Specifies the UUID (unique identifier) of the role to remove from the account.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/items/{category}/{item}/permissions/{permission}":{"delete":{"tags":["permissions"],"summary":"Revoke one permission for a security item","description":"Revokes one permission for a security item for the user account.","operationId":"revokeSingleItemPermission_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"item","in":"path","description":"Security item","required":true,"schema":{"type":"string"}},{"name":"permission","in":"path","description":"Security permission","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/accounts/{id}/categories/{category}/permissions/{permission}":{"delete":{"tags":["permissions"],"summary":"Revoke one permission for a security category","description":"Revokes one permission for a security category for the user account.","operationId":"revokeSingleCategoryPermission_2","parameters":[{"name":"id","in":"path","description":"UUID (unique identifier) of the account","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"category","in":"path","description":"Security category","required":true,"schema":{"type":"string"}},{"name":"permission","in":"path","description":"Security permission","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}}},"components":{"schemas":{"PublishedParameter":{"required":["name","useDefaultValue"],"type":"object","properties":{"name":{"type":"string","description":"The name of the published parameter"},"value":{"type":"object","description":"The value of the published parameter"},"useDefaultValue":{"type":"boolean","description":"Whether the default value should be used"}},"description":"The published parameters used to run the workspace"},"PermissionMetadataResponse":{"type":"object","properties":{"category":{"type":"string","description":"Name of the security category"},"permissions":{"type":"array","description":"Available permissions","items":{"type":"string","description":"Available permissions"}}}},"DeploymentParameterText":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/DeploymentParameterRequest"}]},"TestEventGridPublicationRequest":{"required":["publisherName","webhookEndpoint"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"webhookEndpoint":{"type":"string","description":"The WebHook endpoint from which to receive events. The ID parameter acts as an access token to verify that the event is coming from Azure Event Grid and should be kept private. Azure Event Grid only supports publicly accessible HTTPS webhook endpoints using a valid certificate."}}}]},"BasicConnectionPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/BasicConnectionResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewEngineRuleProp":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of engine property"}}},"TestExistingImapPublicationRequest":{"required":["fetchOption","filterType","imapAccount","imapPort","imapSecurity","imapServer","pollInterval","publisherName","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"imapServer":{"type":"string","description":"The mail exchange server domain name or IP address used for receiving email"},"imapPort":{"type":"integer","description":"The mail exchange TCP port used for receiving email","format":"int32","example":993},"imapAccount":{"type":"string","description":"The email account used for receiving email over IMAP. IMAP access must be enabled on this account. You cannot create multiple IMAP Publishers that reference the same address."},"imapPassword":{"type":"string","description":"The email account password used for receiving email over IMAP"},"imapSecurity":{"type":"string","description":"The encryption mechanism used for the IMAP connection","enum":["sslTls","startTls","none"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified IMAP server for email","format":"int32"},"fetchOption":{"type":"string","description":"Whether to fetch all unread messages from the inbox or only messages received after the previous fetch","enum":["newEmailsOnly","unreadEmails"]},"filterType":{"type":"string","description":"The filter, case-insensitive string match or regular expression, against the email subject line","enum":["simple","regex"]},"subjectFilter":{"type":"string","description":"Only fetch messages where the subject satisfies the filter. Wildcard characters are not supported. If the filter is left blank, then all unread/new messages will be fetched."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"UpdateDataDownloadRequest":{"required":["registered","writers"],"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"reader":{"type":"string","description":"Reader to replace by HTTP body or internet download"},"writers":{"type":"array","description":"Writers to include in Data Download zip file","items":{"type":"string","description":"Writers to include in Data Download zip file"}},"zipLayout":{"type":"object","additionalProperties":{"type":"string","description":"Override default paths for output writers in zip file"},"description":"Override default paths for output writers in zip file"}},"description":"Data Download service properties"},"WebSocketPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"url":{"type":"string","description":"The URL of the WebSocket server"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications. In this case, the requesting application is the Notification Service Publisher."}}},"BroadcastMessagePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/BroadcastMessageResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdatePasswordRequest":{"required":["currentPassword","newPassword","url"],"type":"object","properties":{"type":{"type":"string","description":"Type of the Remote Engine connection.","enum":["standard","snowflake"]},"url":{"type":"string","description":"URL of the Remote Engine."},"currentPassword":{"type":"string","description":"Current password to connect to Remote Engine."},"newPassword":{"type":"string","description":"New password to update on Remote Engine."}},"discriminator":{"propertyName":"type"}},"UpdateRemoteEngineConnectionRequest":{"required":["name","url","username"],"type":"object","properties":{"type":{"type":"string","description":"Type of the Remote Engine connection.","enum":["standard","snowflake"]},"name":{"type":"string","description":"Name of the Remote Engine connection."},"url":{"type":"string","description":"URL of the Remote Engine."},"username":{"type":"string","description":"User to connect to Remote Engine."},"password":{"type":"string","description":"Password to connect to Remote Engine."},"queues":{"uniqueItems":true,"type":"array","description":"Queues to assign to the Remote Engine.","items":{"type":"string","description":"Queues to assign to the Remote Engine."}},"proxyConfiguration":{"$ref":"#/components/schemas/UpdateProxyConfigRequest"},"numStandardEngines":{"type":"integer","description":"Number of Standard Engines.","format":"int32"},"numDynamicEngines":{"type":"integer","description":"Number of CPU-Usage Engines.","format":"int32"}},"discriminator":{"propertyName":"type"}},"ImportEntraIDRoleRequest":{"required":["roleID"],"type":"object","properties":{"roleID":{"type":"string","description":"The object id of the Microsoft Entra (Azure AD) security group.","format":"uuid"},"roleName":{"type":"string","description":"Name of the FME Flow role. If not supplied, will be automatically generated from the imported group."}}},"TestWebSocketPublicationRequest":{"required":["publisherName","streamID","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications. In this case, the requesting application is the Notification Service Publisher."}}}]},"HealthCheckComponent":{"type":"object","properties":{"component":{"type":"string","enum":["cleanup","configuration","connections","core","notifier","relayer","resources","scheduler","queue"]},"status":{"type":"string","enum":["up","down"]}},"description":"The status of each component involved in the health check"},"TestExistingHttpSubscriptionRequest":{"required":["acceptHeader","contentType","requestType","subscriberName","url","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"requestType":{"type":"string","description":"The type of HTTP request","enum":["get","post","put","delete"]},"url":{"type":"string","description":"The URL to which notifications on the associated topics are delivered via HTTP POST"},"httpUsername":{"type":"string","description":"The username when the target URL requires HTTP authentication"},"httpPassword":{"type":"string","description":"The user password when the target URL requires HTTP authentication"},"acceptHeader":{"type":"string","description":"Format of the Accept request HTTP header: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"contentType":{"type":"string","description":"The format in which to deliver content: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"contentTemplate":{"type":"string","description":"The message body content. If specified, this message replaces the incoming message body."}}}]},"TagResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the tag","format":"uuid"},"tag":{"type":"string","description":"Name of the tag"},"count":{"type":"integer","description":"Number of resources the tag is assigned to","format":"int64"}},"description":"Items in this results page"},"JobRuleResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the job routing rule","format":"uuid"},"type":{"type":"string","description":"Type of job routing rule","enum":["repository","property"]},"name":{"type":"string","description":"Name of job routing rule"},"rule":{"type":"string","description":"Job routing rule"},"queue":{"type":"string","description":"Queue to routing job to"},"order":{"type":"integer","description":"Order identifier","format":"int64"},"enabled":{"type":"boolean","description":"Indicates if job routing rule is enabled"}},"description":"Items in this results page"},"TestSmtpPublicationRequest":{"required":["emailUserName","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"emailUserName":{"type":"string","description":"The username of the email address on the FME Flow host system that receives the notification email. For example, if the FME Flow host name is services.internal, and the email address is user@services.internal, enter user."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."}}}]},"HostProperties":{"type":"object","properties":{"physicalMemory":{"type":"integer","description":"The physical memory of the host which this engine resides on","format":"int64"},"processorCount":{"type":"integer","description":"The processor count of the host which this engine resides on","format":"int64"}},"description":"Host properties for the engine"},"DataVirtualizationEndpointSummaryResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the endpoint","format":"uuid"},"path":{"type":"string","description":"Path of the endpoint"},"operation":{"type":"string","description":"Operation this endpoint will perform","enum":["get","post","put","delete"]},"summary":{"type":"string","description":"Short summary of the endpoint"},"tags":{"type":"array","description":"Tags associated with the endpoint","items":{"$ref":"#/components/schemas/DataVirtualizationEndpointTagResponse"}},"security":{"$ref":"#/components/schemas/DataVirtualizationEndpointSecurityResponse"},"responseType":{"type":"string","description":"If `workspace`, the endpoint response will be determined by a workspace. If `manual`, a static response message can be defined","enum":["workspace","manual"]},"workspaceDetails":{"$ref":"#/components/schemas/DataVirtualizationEndpointWorkspaceDetailsResponse"},"lastUpdated":{"type":"string","description":"When the endpoint or its assigned workspace was last updated","format":"date-time"},"caching":{"$ref":"#/components/schemas/DataVirtualizationEndpointCachingResponse"},"jobExpiry":{"$ref":"#/components/schemas/DataVirtualizationEndpointJobExpiryResponse"},"asyncProcessing":{"$ref":"#/components/schemas/DataVirtualizationEndpointAsyncResponse"}},"description":"Items in this results page"},"DataVirtualizationSchemaPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DataVirtualizationSchemaSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TestRemoteEngineConnectionRequest":{"required":["password","url","username"],"type":"object","properties":{"type":{"type":"string","description":"Type of the Remote Engine connection.","enum":["standard","snowflake"]},"url":{"type":"string","description":"URL of the Remote Engine."},"username":{"type":"string","description":"User to connect to Remote Engine."},"password":{"type":"string","description":"Password to connect to Remote Engine."}},"discriminator":{"propertyName":"type"}},"UpdateJobSubmitterRequest":{"required":["registered"],"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"reader":{"type":"string","description":"Reader to replace with HTTP body or internet download"}},"description":"Job Submitter service properties"},"TokenConnectionPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/TokenConnectionResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"DataVirtualizationEndpointWorkspaceDetailsResponse":{"type":"object","properties":{"workspace":{"type":"string","description":"The workspace used to determine the endpoint response"},"workspaceStatus":{"type":"string","description":"Whether a workspace is unassigned, assigned but needs authoring, assigned but needs updating, or assigned and up-to-date","enum":["unassigned","needsAuthoring","needsUpdating","assigned"]},"inheritQueue":{"type":"boolean","description":"Whether the endpoint will inherit the queue of the API"},"queue":{"type":"string","description":"If inheritQueue is `false`, select the assigned queue for all jobs run by the registered workspace"}},"description":"Workspace settings of the endpoint"},"TestFtpWatchPublicationRequest":{"required":["connectionType","encryption","eventsToWatchFor","host","path","pollInterval","port","publisherName","verifyCertificate","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"path":{"type":"string","description":"The location on the FTP server to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified FTP server to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"RemoteEngineConnectionResponse":{"type":"object","properties":{"type":{"type":"string","description":"Type of the Remote Engine connection.","enum":["standard","snowflake"]},"id":{"type":"string","description":"UUID of the role","format":"uuid"},"name":{"type":"string","description":"Name of the Remote Engine connection."},"url":{"type":"string","description":"URL of the Remote Engine."},"username":{"type":"string","description":"User to connect to Remote Engine."},"password":{"type":"string","description":"Password to connect to Remote Engine."},"queues":{"type":"array","description":"Queues to assign to the Remote Engine.","items":{"type":"string","description":"Queues to assign to the Remote Engine."}},"status":{"type":"string","description":"Connection status of Remote Engine.","enum":["offline","online","initializing","unlicensed"]},"ready":{"type":"boolean","description":"Indicates if queues on Remote Engine are ready to receive jobs."},"lastUpdated":{"type":"string","description":"Date of last update to connection.","format":"date-time"},"proxyConfiguration":{"$ref":"#/components/schemas/ProxyConfigResponse"},"numStandardEngines":{"type":"integer","description":"Number of Standard Engines.","format":"int32"},"numDynamicEngines":{"type":"integer","description":"Number of CPU-Usage Engines.","format":"int32"}},"description":"Items in this results page","discriminator":{"propertyName":"type"}},"TestExistingFtpWatchPublicationRequest":{"required":["connectionType","encryption","eventsToWatchFor","host","path","pollInterval","port","publisherName","verifyCertificate","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"path":{"type":"string","description":"The location on the FTP server to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified FTP server to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"TestFtpSubscriptionRequest":{"required":["connectionType","encryption","host","port","subscriberName","transferType","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"transferType":{"type":"string","description":"The transfer method","enum":["auto","ascii","binary"]},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"DataVirtualizationApiAsyncResponse":{"type":"object","properties":{"asyncEnabled":{"type":"boolean","description":"Whether asynchronous processing is enabled"},"asyncResultExpiryInSeconds":{"type":"integer","description":"Asynchronous result data expiry in seconds","format":"int64"}},"description":"Asynchronous processing configuration for the API"},"UpdateSnsSubscriptionRequest":{"required":["accessKeyID","subscriberName","topicArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"topicArn":{"type":"string","description":"The ARN of the Amazon Web Services (AWS) SNS Topic"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SNS Topic"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SNS Topic"},"subject":{"type":"string","description":"The subject of the Amazon Web Services (AWS) SNS Topic"},"contentTemplate":{"type":"string","description":"The default message to publish to the Amazon Web Services (AWS) SNS Topic. Can be up to 64 KB of Unicode text."}}}]},"EntraIDPrimaryTenantResponse":{"type":"object","properties":{"tenantID":{"type":"string","description":"Directory (tenant) ID","format":"uuid"},"name":{"type":"string","description":"Name of the Azure AD tenant"},"tenantType":{"type":"string","description":"Indicates whether the tenant is primary or secondary","enum":["primary","secondary"]},"lastSync":{"type":"string","description":"Date/time when the active directory was last synchronized","format":"date-time"},"syncEnabled":{"type":"boolean","description":"Specifies whether synchronizing users and groups for the Azure AD tenant is enabled or not."},"syncIntervalSeconds":{"type":"integer","description":"If syncEnabled is true, this interval specifies how often to synchronize Azure AD tenant users and groups, in seconds.","format":"int32"},"clientID":{"type":"string","description":"Application (client) ID","format":"uuid"},"clientSecret":{"type":"string","description":"Client secret for the application"}}},"Link":{"required":["refreshMode","viewFormat","viewRefreshInterval","viewRefreshMode","viewRefreshTime"],"type":"object","properties":{"viewRefreshMode":{"type":"string","description":"How KML Network Link is refreshed on view changes","enum":["never","onStop","onRequest","onRegion"]},"viewRefreshTime":{"type":"integer","description":"Seconds to wait before refresh (when viewRefreshMode is 'onStop')","format":"int32"},"viewFormat":{"type":"string","description":"Query string format that is appended to the KML Network Link"},"refreshMode":{"type":"string","description":"How KML Network Link is refreshed","enum":["onChange","onInterval","onExpire"]},"viewRefreshInterval":{"type":"integer","description":"Seconds to wait before refresh (when refreshMode is 'onInterval')","format":"int32"}},"description":"KML Network Link refresh properties"},"UpdateEntraIDPrimaryTenantRequest":{"required":["tenantType"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateEntraIDTenantRequest"},{"type":"object","properties":{"clientID":{"type":"string","description":"Application (client) ID","format":"uuid"},"clientSecret":{"type":"string","description":"Client secret for the application"}}}]},"WorkspaceResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the repository item"},"title":{"type":"string","description":"Title of the repository item"},"type":{"type":"string","description":"Type of repository item","enum":["workspace","customFormat","customTransformer","template"]},"buildNumber":{"type":"integer","description":"Build number of FME Form that this item was created or updated with.","format":"int64"},"category":{"type":"string","description":"Category the item is in"},"history":{"type":"string","description":"The history of the item"},"lastSaveDate":{"type":"string","description":"Last date the repository item was saved","format":"date-time"},"lastPublishDate":{"type":"string","description":"Last date the repository item was published","format":"date-time"},"lastSaveBuild":{"type":"string","description":"Last saved build of the item"},"legalTermsConditions":{"type":"string","description":"Legal Terms and Conditions for using the item"},"requirements":{"type":"string","description":"The requirements for this item"},"requirementsKeyword":{"type":"string","description":"The requirements keyword for this item"},"resources":{"type":"array","description":"Resources belonging to and used by the item","items":{"$ref":"#/components/schemas/Resource"}},"usage":{"type":"string","description":"The ways this item is used"},"username":{"type":"string","description":"The name of the user who added this item"},"fileSize":{"type":"integer","description":"Amount of storage, in bytes, occupied on the server by this item","format":"int64"},"favorite":{"type":"boolean","description":"Whether the item is a favorite"},"averageCpuPercent":{"type":"number","description":"The average CPU percent when running this workspace","format":"double"},"averagePeakMemoryUsage":{"type":"integer","description":"The average peak memory usage in kilobytes when running this workspace","format":"int64"},"averageCpuTime":{"type":"integer","description":"The average CPU time in milliseconds when running this workspace","format":"int64"},"totalRuns":{"type":"integer","description":"The total number of times this workspace has been run","format":"int64"},"averageElapsedTime":{"type":"integer","description":"The average elapsed time in milliseconds when running this workspace","format":"int64"},"description":{"type":"string","description":"A human-readable description of the workspace"},"datasets":{"$ref":"#/components/schemas/Datasets"},"services":{"$ref":"#/components/schemas/Services"},"parameters":{"type":"array","description":"Published parameters defined for this workspace","items":{"type":"object","additionalProperties":{"type":"object","description":"Published parameters defined for this workspace"},"description":"Published parameters defined for this workspace"}}}},"UpdateSsoPropertiesRequest":{"required":["username"],"type":"object","properties":{"username":{"type":"string","description":"Kerberos authentication ID of service account used for single sign-on authentication. Required when 'authentication' is set to SSO"},"password":{"type":"string","description":"Password of service account used for single sign-on authentication. If null, existingpassword will be preserved. If non-null, but also be non-empty."}},"description":"SSO user properties"},"StreamSummaryResponse":{"required":["repository","workspace"],"type":"object","properties":{"id":{"type":"string","description":"UUID of the stream","format":"uuid"},"queueName":{"type":"string","description":"Internal queue identifier for Kubernetes deployments"},"ownerID":{"type":"string","description":"UUID of the user that owns the stream","format":"uuid"},"owner":{"type":"string","description":"Owner of the stream"},"name":{"type":"string","description":"Display name of the stream"},"state":{"type":"string","description":"State of the stream","enum":["stale","inSync","deleting"]},"description":{"type":"string","description":"Description of the stream"},"lastUpdatedUserID":{"type":"string","description":"User who last updated, enabled, or disabled the stream","format":"uuid"},"enabled":{"type":"boolean","description":"Whether the stream is enabled or not"},"created":{"type":"string","description":"When the stream was created","format":"date-time"},"lastUpdated":{"type":"string","description":"When the stream was last modified","format":"date-time"},"engines":{"$ref":"#/components/schemas/StreamEngineInfo"},"repository":{"type":"string","description":"The repository of the job to run"},"workspace":{"pattern":".*.(?i)fmw","type":"string","description":"The workspace of the job to run","example":"string"},"logDebug":{"type":"boolean","description":"Whether the stream will run with debug logging or not"},"engineRuleExists":{"type":"boolean","description":"Whether the stream already has engine rule or not"},"type":{"type":"string","description":"Type of stream","enum":["standard","remote"]},"remoteConfiguration":{"$ref":"#/components/schemas/StreamRemoteConfig"}},"description":"Items in this results page"},"NewWindowsLdapServerRequest":{"required":["authentication","connectionOptions","encryption","host","name","port"],"type":"object","properties":{"name":{"type":"string","description":"Name of the LDAP server"},"host":{"type":"string","description":"LDAP server host"},"port":{"type":"integer","description":"LDAP server port","format":"int32"},"encryption":{"type":"string","description":"Encryption mode","enum":["none","ssl","startTls"]},"connectionOptions":{"$ref":"#/components/schemas/LdapServerConnectionOptionsRequest"},"authentication":{"type":"string","description":"Authentication mechanism","enum":["basic","sasl","sso"]},"saslAuthenticationProperties":{"$ref":"#/components/schemas/SaslAuthenticationPropertiesRequest"},"searchProperties":{"$ref":"#/components/schemas/SearchPropertiesRequest"},"syncOptions":{"$ref":"#/components/schemas/SyncOptionsRequest"},"lookupAttributes":{"$ref":"#/components/schemas/WindowsLookupAttributesRequest"},"ssoProperties":{"$ref":"#/components/schemas/NewSsoPropertiesRequest"}}},"AutomationPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/AutomationResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TestWorkspaceSubscriptionRequest":{"required":["repository","subscriberName","workspace"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"repository":{"type":"string","description":"The repository in which the Workspace resides"},"workspace":{"type":"string","description":"The Workspace to subscribe to"},"queue":{"type":"string","description":"The queue in which to run the job"},"maxTimeInQueue":{"type":"integer","description":"The length of time after which a job that is waiting in queue does not execute","format":"int32"},"maxJobRuntime":{"minimum":1,"type":"integer","description":"The time a job will remain in the running state","format":"int32"},"runUntilCancelled":{"type":"boolean","description":"Whether to run the job continuously forever, until explicitly cancelled"},"publishedParameters":{"type":"array","description":"The published parameters of the Workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"publishedReaderOverride":{"type":"string","description":"The source dataset published parameter"},"publishedWriterForNotification":{"type":"string","description":"The destination dataset published parameter"}}}]},"DeploymentParameterDropdown":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/DeploymentParameterRequest"},{"type":"object","properties":{"choiceSettings":{"$ref":"#/components/schemas/ChoiceSettings"}}}]},"PagePackageResponse":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/PackageResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"Notification":{"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"reader":{"type":"string","description":"Reader to replace by HTTP body or internet download"},"topics":{"type":"array","description":"Topics to subscribe","items":{"type":"string","description":"Topics to subscribe"}},"successTopics":{"type":"array","description":"Topics to notify on success","items":{"type":"string","description":"Topics to notify on success"}},"failureTopics":{"type":"array","description":"Topics to notify on failure","items":{"type":"string","description":"Topics to notify on failure"}},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Properties for the service"},"description":"Properties for the service"}},"description":"Notification service properties"},"WindowsLdapServerPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/WindowsLdapServerResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"ItemSummaryResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the repository item"},"title":{"type":"string","description":"Title of the repository item"},"description":{"type":"string","description":"Description of the repository item"},"type":{"type":"string","description":"Type of the repository item","enum":["workspace","customFormat","customTransformer","template"]},"repositoryName":{"type":"string","description":"Name of the repository the item is part of"},"lastSaveDate":{"type":"string","description":"Last date the repository item was saved","format":"date-time"},"lastPublishDate":{"type":"string","description":"Last date the repository item was published","format":"date-time"},"lastPublishUserID":{"type":"string","description":"UUID of the last user to publish the repository item","format":"uuid"},"lastPublishUser":{"type":"string","description":"The last user to publish the repository item"},"totalFileSize":{"type":"integer","description":"Total size of all files that are part of the repository item","format":"int64"},"fileCount":{"type":"integer","description":"Number of files that are part of the repository item","format":"int64"},"averageCpuPercent":{"type":"number","description":"The average CPU percent when running this item (only available for type workspace)","format":"double"},"averagePeakMemoryUsage":{"type":"integer","description":"The average peak memory usage in kilobytes when running this item (only available for type workspace)","format":"int64"},"averageCpuTime":{"type":"integer","description":"The average CPU time in milliseconds when running this item (only available for type workspace)","format":"int64"},"totalRuns":{"type":"integer","description":"The total number of times running this item (only available for type workspace)","format":"int64"},"averageElapsedTime":{"type":"integer","description":"The average elapsed time in milliseconds when running this item (only available for type workspace)","format":"int64"},"favorite":{"type":"boolean","description":"Whether the repository item is a favorite"}},"description":"Items in this results page"},"LatLonAltBox":{"type":"object","properties":{"north":{"type":"number","description":"Bounding box northern edge, in degrees (-90 to +90)","format":"double"},"east":{"type":"number","description":"Bounding box eastern edge, in degrees (-180 to +180)","format":"double"},"south":{"type":"number","description":"Bounding box southern edge, in degrees (-90 to +90)","format":"double"},"west":{"type":"number","description":"Bounding box western edge, in degrees (-180 to +180)","format":"double"}},"description":"Bounding box that describes area of interest"},"NewAutomationRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the automation"},"tags":{"type":"array","description":"Tags associated with the automation","items":{"type":"string","description":"Tags associated with the automation"}}}},"ProjectAsyncExportRequest":{"type":"object","properties":{"includeSensitiveInfo":{"type":"boolean","writeOnly":true},"skipValidation":{"type":"boolean","writeOnly":true},"skipMissingItems":{"type":"boolean","writeOnly":true},"resourceName":{"type":"string","writeOnly":true},"exportPackage":{"type":"string","writeOnly":true},"successTopic":{"type":"string","writeOnly":true},"failureTopic":{"type":"string","writeOnly":true},"selectedItems":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/ItemId"}},"excludeAllSelectableItems":{"type":"boolean","writeOnly":true}}},"NewWebSocketSubscriptionRequest":{"required":["name","streamID","subscriberName","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications."},"template":{"type":"string","description":"The message sent in the stream"}}}]},"JobLogLine":{"type":"object","properties":{"number":{"type":"integer","description":"Line number","format":"int64"},"time":{"type":"string","description":"Time stamp","format":"date-time"},"elapsed":{"type":"string","description":"Time elapse since last line"},"duration":{"type":"string","description":"Duration of line event"},"status":{"type":"string","description":"Status"},"message":{"type":"string","description":"Message"},"line":{"type":"string","description":"Raw log line"}},"description":"Items in this results page"},"TestS3WatchPublicationRequest":{"required":["accessKeyID","bucket","eventsToWatchFor","pollInterval","publisherName","secretAccessKey","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The Bucket name in the Amazon Web Services (AWS) S3 account, case-sensitive"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"path":{"type":"string","description":"The folder location in the specified Amazon Web Services (AWS) S3 Bucket to watch for changes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified Amazon Web Services (AWS) S3 Bucket. S3 is a pay-per-use service. Every poll is one request to this service.","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"MigrationTaskIdResponse":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the migration task.","format":"int64"}}},"KMLNetworkLink":{"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"writers":{"type":"array","description":"Writers to include in KML Network Link","items":{"type":"string","description":"Writers to include in KML Network Link"}},"name":{"type":"string","description":"Name of KML Network Link"},"visibility":{"type":"string","description":"Feature visibility (0 for hidden, 1 for visible)"},"description":{"type":"string","description":"Description of KML Network Link"},"link":{"$ref":"#/components/schemas/Link"},"latLonAltBox":{"$ref":"#/components/schemas/LatLonAltBox"},"lod":{"$ref":"#/components/schemas/Lod"},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Properties for the service"},"description":"Properties for the service"}},"description":"KML Network Link service properties"},"HealthCheckResponse":{"type":"object","properties":{"status":{"type":"string","description":"The health status of the application","enum":["ok","disabled","notReady","componentUnavailable"]},"message":{"type":"string","description":"The status message of the health check"},"components":{"uniqueItems":true,"type":"array","description":"The status of each component involved in the health check","items":{"$ref":"#/components/schemas/HealthCheckComponent"}},"initializationTasks":{"uniqueItems":true,"type":"array","description":"The status of each initialization task involved in the health check","items":{"$ref":"#/components/schemas/HealthCheckInitializationTask"}}}},"ProjectItemType":{"type":"string","description":"The type of the resource being added.","enum":["automation","cleanupTask","connection","customFormat","customTransformer","deploymentParameter","fmepackage","project","publication","repository","resourceConnection","resourcePath","role","schedule","automationApp","galleryApp","workspaceApp","stream","subscription","template","token","topic","user","workspace","dataVirtualizationApi"]},"UpdateCleanupTaskRequest":{"required":["enabled","maxAgeInSeconds","sourcePath","sourceResourceConnection"],"type":"object","properties":{"maxAgeInSeconds":{"minimum":0,"type":"integer","description":"Maximum age (seconds) of files, jobs, system events, or tokens to keep before cleaning","format":"int64"},"description":{"type":"string","description":"Description of the cleanup task"},"enabled":{"type":"boolean","description":"Whether the cleanup task is currently enabled or disabled"},"filter":{"$ref":"#/components/schemas/CleanupTaskFilter"},"sourceResourceConnection":{"type":"string","description":"The resource connection where the desired files to cleanup will be found, e.g. \"FME_SHAREDRESOURCE_LOG\""},"sourcePath":{"type":"string","description":"The path (from the resource connection) to process files from, e.g. \"automations/old\", with no trailing or leading slashes"}}},"BasicConnectionResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the connection"},"category":{"type":"string","description":"The category of the connection","enum":["database","basic","token","oauthV2"]},"type":{"type":"string","description":"The type of the connection"},"owner":{"type":"string","description":"The owner of the connection"},"shareable":{"type":"boolean","description":"Whether the connection is shareable"},"username":{"type":"string","description":"The username for a basic connection"},"password":{"type":"string","description":"The password for a basic connection"},"authenticationMethod":{"type":"string","description":"The HTTP authentication method","enum":["basic","digest","ntlm","none"]}}},"NewDatabaseConnectionRequest":{"required":["category","name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewConnectionRequest"},{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters for the database connection"},"description":"The parameters for the database connection"}}}]},"MultiWebSessionsResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether multiple web sessions are allowed or not"}}},"UpdateAutomationRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the automation"},"tags":{"type":"array","description":"Tags associated with the automation. If a tag that doesn't exist is specified, the tag will be created.","items":{"type":"string","description":"Tags associated with the automation. If a tag that doesn't exist is specified, the tag will be created."}}}},"DataDownload":{"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"reader":{"type":"string","description":"Reader to replace by HTTP body or internet download"},"writers":{"type":"array","description":"Writers to include in Data Download zip file","items":{"type":"string","description":"Writers to include in Data Download zip file"}},"zipLayout":{"type":"object","additionalProperties":{"type":"string","description":"Override default paths for output writers in zip file"},"description":"Override default paths for output writers in zip file"},"successTopics":{"type":"array","description":"Topics to notify on success","items":{"type":"string","description":"Topics to notify on success"}},"failureTopics":{"type":"array","description":"Topics to notify on failure","items":{"type":"string","description":"Topics to notify on failure"}},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Properties for the service"},"description":"Properties for the service"}},"description":"Data Download service properties"},"AutomationEnableRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled/Disabled state of the automation"},"runMode":{"type":"string","description":"Determines how messages are logged for the automation.In production mode, messages are logged to files. In debug mode, messages are logged to the DB.","nullable":true,"example":"production","enum":["production","debug"]}}},"AttributeMap":{"required":["email","firstName","lastName","role","userID"],"type":"object","properties":{"userID":{"type":"string","description":"The idp attribute to map to the user name for newly created accounts"},"firstName":{"type":"string","description":"The idp attribute to map to the first name for newly created accounts"},"lastName":{"type":"string","description":"The idp attribute to map to the last name for newly created accounts"},"email":{"type":"string","description":"The idp attribute to map to the email for newly created accounts"},"role":{"type":"string","description":"The idp attribute to map to the role for newly created accounts"}},"description":"The map of attributes which will indicate what attributes are mapped to what fields when creating user accounts"},"NewStreamRequest":{"required":["name","repository","workspace"],"type":"object","properties":{"name":{"type":"string","description":"Display name of the stream"},"description":{"type":"string","description":"Description of the stream"},"enabled":{"type":"boolean","description":"Whether the stream is enabled or not"},"repository":{"type":"string","description":"The repository of the job to run"},"workspace":{"pattern":".*.(?i)fmw","type":"string","description":"The workspace of the job to run","example":"string"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"logDebug":{"type":"boolean","description":"Whether the stream will run with debug logging or not"},"type":{"type":"string","description":"The type of stream to create","enum":["standard","remote"]},"remoteConfiguration":{"$ref":"#/components/schemas/StreamRemoteConfig"}}},"TestRemoteEngineConnectionRequestSnowflake":{"required":["password","snowflakeAuthentication","url","username"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestRemoteEngineConnectionRequest"},{"type":"object","properties":{"snowflakeAuthentication":{"$ref":"#/components/schemas/NewSnowflakeAuthRequest"}}}]},"ActivePeriodResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of active period","format":"uuid"},"name":{"type":"string","description":"Name of active period"},"description":{"type":"string","description":"Description of active period"},"startDate":{"type":"string","description":"Start date of active period","format":"date-time"},"endDate":{"type":"string","description":"End date of active period","format":"date-time"},"startTime":{"type":"string","description":"Start time of active period","format":"date-time"},"endTime":{"type":"string","description":"End time of active period","format":"date-time"},"recurrence":{"type":"string","description":"Recurrence configuration of active period"},"engineRules":{"type":"array","description":"Engine rules assigned to the active period","items":{"$ref":"#/components/schemas/ActivePeriodEngineRuleAssignmentResponse"}}},"description":"Items in this results page"},"ProxyCredentialsResponse":{"type":"object","properties":{"username":{"type":"string","description":"The username used for proxy authentication"},"password":{"type":"string","description":"The password used for proxy authentication"},"authenticationMethod":{"type":"string","description":"The authentication method","enum":["basic","ntlm","digest"]}},"description":"The authentication credentials for the proxy"},"UpdateJobRuleRequest":{"required":["enabled","name","queue","rule","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of job routing rule"},"type":{"type":"string","description":"Type of job routing rule","enum":["repository","property"]},"rule":{"type":"string","description":"Job routing rule"},"queue":{"type":"string","description":"Queue to route job to"},"enabled":{"type":"boolean","description":"Indicates if job routing rule is enabled"}}},"UpdateSAMLConfigRequest":{"required":["attributeMap","autoAddNewUsers","defaultRole","enabled","idpDetails","signRequests","useMetadataFile"],"type":"object","properties":{"signRequests":{"type":"boolean","description":"Whether the SAML response is encrypted."},"useMetadataFile":{"type":"boolean","description":"Whether the identity provider metadata is used for configuration."},"idpDetails":{"$ref":"#/components/schemas/NewIdentityProviderDetails"},"autoAddNewUsers":{"type":"boolean","description":"Whether new users are automatically added to FME Flow."},"defaultRole":{"type":"string","description":"The default role under which new users are added","format":"uuid"},"attributeMap":{"$ref":"#/components/schemas/AttributeMap"},"enabled":{"type":"boolean","description":"Whether the SAML configuration is enabled"}}},"PasswordReuseCheckResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether password reuse checks are applied when a user attempts to change their password"},"numPasswordsIneligibleForReuse":{"type":"integer","description":"Number of recently used passwords which a new password must differ from","format":"int32"}}},"UpdateFtpSubscriptionRequest":{"required":["connectionType","encryption","host","port","subscriberName","transferType","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"transferType":{"type":"string","description":"The transfer method","enum":["auto","ascii","binary"]},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"GenericLookupAttributesResponse":{"type":"object","properties":{"fullName":{"type":"string","description":"Attribute containing the full name of the LDAP user."},"email":{"type":"string","description":"Attribute containing the email address of the LDAP user"},"group":{"type":"string","description":"Attribute containing the name of the LDAP group. When omitted, 'sAMAccountName' is used"},"username":{"type":"string","description":"Attribute containing the name of the LDAP user. When omitted, 'sAMAccountName' is used"},"memberOf":{"type":"string","description":"Attribute containing the group membership of a user or group. When omitted, group membership lookups are not used"}},"description":"Attributes used to fetch user and group details"},"DeploymentParameterPassword":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/DeploymentParameterRequest"}]},"DataVirtualizationApiAsyncRequest":{"required":["asyncEnabled","asyncResultExpiryInSeconds"],"type":"object","properties":{"asyncEnabled":{"type":"boolean","description":"Whether asynchronous processing is enabled"},"asyncResultExpiryInSeconds":{"type":"integer","description":"Asynchronous result data expiry in seconds","format":"int64"}},"description":"Asynchronous processing configuration for the API"},"AllowedRoleResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the role","format":"uuid"},"name":{"type":"string","description":"Name of the role"}},"description":"IDs of roles that are authorized to run endpoints in this API"},"SftpSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"host":{"type":"string","description":"The SFTP host name"},"port":{"type":"integer","description":"The SFTP port number","format":"int32"},"username":{"type":"string","description":"The SFTP username for authentication"},"password":{"type":"string","description":"The SFTP user password for authentication"},"verifyHostKey":{"type":"boolean","description":"Whether to verify the host key for the server being connected to"},"knownHostsFile":{"type":"string","description":"The path to the known_hosts file that contains the public keys for any servers you wish to connect to, if verifying host key. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"localSourcePath":{"type":"string","description":"The source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file"}}},"CategoryPermissionResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the security category"},"permissions":{"type":"array","description":"Permissions granted for this category","items":{"type":"string","description":"Permissions granted for this category"}}}},"MigrationBackupDownloadRequest":{"required":["packageName"],"type":"object","properties":{"packageName":{"type":"string","description":"Name of the export package"}}},"DataVirtualizationTagRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the tag"},"description":{"type":"string","description":"Description of the tag"}}},"TestExistingJmsPublicationRequest":{"required":["connectionFactory","destinations","publisherName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."}}}]},"ProjectTasksPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ProjectTaskResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdateKMLNetworkLinkRequest":{"required":["description","link","name","registered","visibility","writers"],"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"writers":{"type":"array","description":"Writers to include in KML Network Link","items":{"type":"string","description":"Writers to include in KML Network Link"}},"name":{"type":"string","description":"Name of KML Network Link"},"visibility":{"type":"string","description":"Feature visibility (0 for hidden, 1 for visible)"},"description":{"type":"string","description":"Description of KML Network Link"},"link":{"$ref":"#/components/schemas/Link"},"latLonAltBox":{"$ref":"#/components/schemas/LatLonAltBox"},"lod":{"$ref":"#/components/schemas/Lod"}},"description":"KML Network Link service properties"},"ItemId":{"required":["id","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/ImportItemType"},"id":{"type":"string"}}},"EngineProcessInfoResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the FME Engine"},"state":{"type":"string","description":"Process state of the FME Engine","enum":["starting","started","stopping","stopped","unlicensed","unknown"]},"status":{"type":"string","description":"Status of the FME Engine"},"type":{"type":"string","description":"Type of the FME Engine","enum":["standard","dynamic"]}}},"AccountItemPermissionRequest":{"required":["id","permissions"],"type":"object","properties":{"id":{"type":"string","description":"UUID of the account","format":"uuid"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}},"description":"Account permissions granted for this item"},"NewEntraIDSecondaryTenantRequest":{"required":["name","tenantID","tenantType"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewEntraIDTenantRequest"}]},"UpdateEngineRuleRequest":{"required":["enabled","name","queues","rule","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of engine assignment rule"},"type":{"type":"string","description":"Type of engine assignment rule","enum":["name","property"]},"rule":{"type":"string","description":"Engine assignment rule"},"queues":{"type":"array","description":"Queues to assign engines to","items":{"type":"string","description":"Queues to assign engines to"}},"activePeriods":{"type":"array","description":"Active periods to assign to the engine rule","items":{"type":"string","description":"Active periods to assign to the engine rule","format":"uuid"}},"enabled":{"type":"boolean","description":"Indicates if engine assignment rule is enabled"}}},"ImportRoleResponse":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of members of this Azure security group","format":"int32"},"skippedCount":{"type":"integer","description":"Number of members of this Azure security group that were not imported","format":"int32"},"skippedUsers":{"type":"array","description":"List of members that were not imported","items":{"$ref":"#/components/schemas/EntraIDUserResponse"}}}},"DataVirtualizationEndpointCachingResponse":{"type":"object","properties":{"inheritCaching":{"type":"boolean","description":"Whether the endpoint will inherit the caching configuration of the API"},"cacheEnabled":{"type":"boolean","description":"Whether caching is enabled"},"cacheExpiryInSeconds":{"type":"integer","description":"Cache expiry in seconds","format":"int64"}},"description":"Caching configuration of the endpoint"},"LoggerSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"logLevel":{"type":"string","description":"The level of detail of the notification message in the log file","enum":["low","normal","high"]}}},"NewSnowflakeAuthRequest":{"required":["account","endpoint","privateKey","publicKey","role","user"],"type":"object","properties":{"account":{"type":"string","description":"Account to connect to Remote Engine."},"user":{"type":"string","description":"User to connect to Remote Engine."},"role":{"type":"string","description":"Role to connect to Remote Engine."},"endpoint":{"type":"string","description":"Endpoint of the Remote Engine."},"privateKey":{"type":"string","description":"Private key to connect to Remote Engine."},"publicKey":{"type":"string","description":"Public key to connect to Remote Engine."}},"description":"Snowflake configuration for the Remote Engine."},"BroadcastMessageResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the broadcast message","format":"uuid"},"type":{"type":"string","description":"Type of the broadcast message","enum":["user","system"]},"dateUpdated":{"type":"string","description":"Date when the broadcast message was last updated","format":"date-time"},"message":{"type":"string","description":"Message to broadcast"},"title":{"type":"string","description":"Title of the broadcast message"},"severity":{"type":"string","description":"Severity of the broadcast message","enum":["info","warn","critical"]},"enabled":{"type":"boolean","description":"Whether the broadcast message is enabled or not"},"userUpdated":{"type":"string","description":"User that last updated the broadcast message"}},"description":"Items in this results page"},"ScheduleEnableRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled/Disabled state of the schedule"}}},"UpdateEntraIDSecondaryTenantRequest":{"required":["tenantType"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateEntraIDTenantRequest"}]},"TestJmsPublicationRequest":{"required":["connectionFactory","destinations","publisherName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."}}}]},"TestExistingRemoteEngineConnectionRequest":{"type":"object","properties":{"type":{"type":"string","description":"Type of the Remote Engine connection.","enum":["standard","snowflake"]},"url":{"type":"string","description":"URL of the Remote Engine."},"username":{"type":"string","description":"User to connect to Remote Engine."},"password":{"type":"string","description":"Password to connect to Remote Engine."}},"discriminator":{"propertyName":"type"}},"NewEventGridSubscriptionRequest":{"required":["eventType","name","subject","subscriberName","topicEndpoint","topicKey"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"topicEndpoint":{"type":"string","description":"The topic endpoint of the Azure Event Grid Topic"},"topicKey":{"type":"string","description":"The topic access key used to publish events to the Azure Event Grid Topic"},"subject":{"type":"string","description":"The subject used for filtering and routing events"},"eventType":{"type":"string","description":"The event type of the specified subject"},"data":{"type":"string","description":"The event data, specified in key/value pairs, that is published to the specified Azure Event Grid Topic Endpoint."}}}]},"AppStylingRequest":{"type":"object","properties":{"browserTitle":{"type":"string","description":"Browser title"},"footerText":{"type":"string","description":"Footer text"},"backgroundColor":{"type":"string","description":"Background color"}},"description":"Styling for the app"},"DataVirtualizationEndpointTagResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the tag","format":"uuid"},"name":{"type":"string","description":"Name of the tag"}},"description":"Tags associated with the endpoint"},"TokensEnableRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled/Disabled state of the user token"}}},"EnginePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/EngineResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TestSystemEmailPropsRequest":{"required":["connectionSecurity","emailFrom","smtpServer","smtpServerPort"],"type":"object","properties":{"smtpServer":{"type":"string","description":"Mail exchange server domain name or IP address used for sending email."},"smtpServerPort":{"type":"integer","description":"Mail exchange TCP port used for sending email.","format":"int32"},"connectionSecurity":{"type":"string","description":"The encryption mechanism used for the connection.","enum":["sslTls","startTls","none"]},"emailFrom":{"type":"string","description":"Corresponds to the From field in standard email messages. If users reply to the notification email message, it is directed to this email address."},"smtpAccount":{"type":"string","description":"If the SMTP server requires authentication, this is the user name."},"smtpPassword":{"type":"string","description":"If the SMTP server requires authentication, this is the user or app password."},"clientID":{"type":"string","description":"The Microsoft OAuth client ID, if applicable."}}},"RemoteEngineConnectionPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"oneOf":[{"$ref":"#/components/schemas/RemoteEngineConnectionResponse"},{"$ref":"#/components/schemas/RemoteEngineConnectionResponseSnowflake"}]}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewIdentityProviderDetails":{"required":["entityID","ssoURL"],"type":"object","properties":{"ssoURL":{"type":"string","description":"Identity Provider SSO URL"},"entityID":{"type":"string","description":"Identity Provider Issuer"}},"description":"The identity provider details"},"TestExistingSqsSubscriptionRequest":{"required":["accessKeyID","queue","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"queue":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to which you want to send messages"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"contentTemplate":{"type":"string","description":"The default message to send to the Amazon Web Services (AWS) SQS Queue. Can be up to 64 KB of text in any format."}}}]},"UpdateFtpWatchPublicationRequest":{"required":["connectionType","encryption","eventsToWatchFor","host","path","pollInterval","port","publisherName","verifyCertificate","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"path":{"type":"string","description":"The location on the FTP server to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified FTP server to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"NewUdpPublicationRequest":{"required":["name","port","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"port":{"type":"integer","description":"The UDP port to listen to for incoming data packets","format":"int32"}}}]},"NewEngineRuleRequest":{"required":["enabled","name","queues","rule","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of engine assignment rule"},"type":{"type":"string","description":"Type of engine assignment rule","enum":["name","property"]},"rule":{"type":"string","description":"Engine assignment rule"},"queues":{"type":"array","description":"Queues to assign engines to","items":{"type":"string","description":"Queues to assign engines to"}},"activePeriods":{"type":"array","description":"Active periods to assign to the engine rule","items":{"type":"string","description":"Active periods to assign to the engine rule","format":"uuid"}},"enabled":{"type":"boolean","description":"Indicates if engine assignment rule is enabled"}}},"JobLogLinePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/JobLogLine"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"MigrationLogLinePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/MigrationLogLine"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"PasswordResetPropertiesRequest":{"required":["emailSubject","enabled","publicUrl"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether FME Flow password reset is enabled (true) or disabled (false)"},"emailSubject":{"type":"string","description":"Email Subject"},"publicUrl":{"type":"string","description":"Public URL for FME Flow. The link sent in the password reset email will be based on this public URL."}}},"EntraIDUserResponse":{"type":"object","properties":{"azureUserID":{"type":"string","description":"The unique ID of the Azure user","format":"uuid"},"tenantID":{"type":"string","description":"Name of the Azure AD tenant the user belongs to","format":"uuid"},"linkedAccountID":{"type":"string","description":"UUID of the linked account","format":"uuid"},"linkedAccountName":{"type":"string","description":"Name of the linked account"},"fullName":{"type":"string","description":"Full name of the Azure AD user"},"email":{"type":"string","description":"Email address of the Azure AD user"},"userPrincipalName":{"type":"string","description":"The principal name of the Azure AD user"}},"description":"List of members that were not imported"},"SecondsToExpiryRequest":{"required":["secondsToExpiry"],"type":"object","properties":{"secondsToExpiry":{"minimum":0,"type":"integer","description":"Expiration timeout in seconds for the token","format":"int64"}}},"DataVirtualizationEndpointSecurityRequest":{"required":["inheritSecurity"],"type":"object","properties":{"inheritSecurity":{"type":"boolean","description":"Whether the endpoint will inherit the security of the API"},"requireAuthentication":{"type":"boolean","description":"Whether the endpoint requires user authentication to access endpoints. If inheritSecurity is false, requireAuthentication must be specified."},"allowedUsers":{"uniqueItems":true,"type":"array","description":"IDs of users that are authorized to run this endpoint","items":{"type":"string","description":"IDs of users that are authorized to run this endpoint","format":"uuid"}},"allowedRoles":{"uniqueItems":true,"type":"array","description":"IDs of roles that are authorized to run this endpoint","items":{"type":"string","description":"IDs of roles that are authorized to run this endpoint","format":"uuid"}}}},"NewBasicConnectionRequest":{"required":["authenticationMethod","category","name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewConnectionRequest"},{"type":"object","properties":{"authenticationMethod":{"type":"string","description":"The HTTP authentication method","enum":["basic","digest","ntlm","none"]},"username":{"type":"string","description":"The username for a basic connection"},"password":{"type":"string","description":"The password for a basic connection"}}}]},"UdpPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"port":{"type":"integer","description":"The UDP port to listen to for incoming data packets","format":"int32"}}},"EmailRequest":{"required":["currentPassword","email"],"type":"object","properties":{"email":{"type":"string","description":"Email of the user account"},"currentPassword":{"type":"string","description":"The current password of the user account"}}},"QueuePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DetailedQueueResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"EntraIDSecondaryTenantPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/EntraIDSecondaryTenantResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewDirWatchPublicationRequest":{"required":["directory","eventsToWatchFor","name","pollInterval","publisherName","watchFolder","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"directory":{"type":"string","description":"The directory to watch for activity"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"watchFolder":{"type":"boolean","description":"Whether to monitor activities on only files or both files and folders"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified Directory to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear.","format":"int32"}}}]},"TestDropboxSubscriptionRequest":{"required":["accessToken","localSourcePath","remoteUploadDirectory","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"NewBroadcastMessageRequest":{"required":["message","severity","title"],"type":"object","properties":{"message":{"type":"string","description":"Message to broadcast"},"title":{"type":"string","description":"Title of the broadcast message"},"severity":{"type":"string","description":"Severity of the broadcast message","enum":["info","warn","critical"]},"enabled":{"type":"boolean","description":"Whether the broadcast message is enabled or not"}}},"ProxyConfigResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the proxy is enabled or not"},"host":{"type":"string","description":"The proxy host"},"nonProxyHosts":{"type":"array","description":"The lists of hosts that will be accessed without without a proxy","items":{"type":"string","description":"The lists of hosts that will be accessed without without a proxy"}},"port":{"type":"integer","description":"The proxy port","format":"int32"},"scheme":{"type":"string","description":"The proxy scheme"},"requiresAuthentication":{"type":"boolean","description":"Whether the proxy requires authentication or not"},"credentials":{"$ref":"#/components/schemas/ProxyCredentialsResponse"}},"description":"Proxy configuration for the Remote Engine."},"AccountItemPermissionResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the account","format":"uuid"},"name":{"type":"string","description":"Name of the account"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}},"description":"Account permissions granted for this item"},"TestSubscriptionRequest":{"required":["subscriberName"],"type":"object","properties":{"subscriberName":{"type":"string","description":"The communication protocol used for the subscription","enum":["httprequest","sqs","logger","ftp","eventgrid","sns","workspace","dropbox","jms","sftp","s3","email","websocket"]}},"discriminator":{"propertyName":"subscriberName"}},"MigrationBackupResourceRequest":{"required":["packagePath","resourceName"],"type":"object","properties":{"resourceName":{"type":"string","description":"Name of the resource connection where the export package is saved"},"packagePath":{"type":"string","description":"Path of the export package"},"successTopic":{"type":"string","description":"Topic to notify on successful system backup"},"failureTopic":{"type":"string","description":"Topic to notify on failed system backup"}}},"RedundantServerResponse":{"type":"object","properties":{"host":{"type":"string","description":"Server host"},"port":{"type":"integer","description":"Server port","format":"int32"}},"description":"Additional LDAP servers used for maintaining high availability."},"SystemEventsConfigurationPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/SystemEventsConfigurationResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TestSnsSubscriptionRequest":{"required":["accessKeyID","secretAccessKey","subscriberName","topicArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"topicArn":{"type":"string","description":"The ARN of the Amazon Web Services (AWS) SNS Topic"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SNS Topic"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SNS Topic"},"subject":{"type":"string","description":"The subject of the Amazon Web Services (AWS) SNS Topic"},"contentTemplate":{"type":"string","description":"The default message to publish to the Amazon Web Services (AWS) SNS Topic. Can be up to 64 KB of Unicode text."}}}]},"UpdateImapPublicationRequest":{"required":["fetchOption","filterType","imapAccount","imapPort","imapSecurity","imapServer","pollInterval","publisherName","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"imapServer":{"type":"string","description":"The mail exchange server domain name or IP address used for receiving email"},"imapPort":{"type":"integer","description":"The mail exchange TCP port used for receiving email","format":"int32","example":993},"imapAccount":{"type":"string","description":"The email account used for receiving email over IMAP. IMAP access must be enabled on this account. You cannot create multiple IMAP Publishers that reference the same address."},"imapPassword":{"type":"string","description":"The email account password used for receiving email over IMAP"},"imapSecurity":{"type":"string","description":"The encryption mechanism used for the IMAP connection","enum":["sslTls","startTls","none"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified IMAP server for email","format":"int32"},"fetchOption":{"type":"string","description":"Whether to fetch all unread messages from the inbox or only messages received after the previous fetch","enum":["newEmailsOnly","unreadEmails"]},"filterType":{"type":"string","description":"The filter, case-insensitive string match or regular expression, against the email subject line","enum":["simple","regex"]},"subjectFilter":{"type":"string","description":"Only fetch messages where the subject satisfies the filter. Wildcard characters are not supported. If the filter is left blank, then all unread/new messages will be fetched."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"UpdateEntraIDTenantRequest":{"required":["tenantType"],"type":"object","properties":{"tenantType":{"type":"string","description":"Specifies the current type of the tenant, which must be included in the request. Note that the tenant type cannot be changed.","enum":["primary","secondary"]},"name":{"type":"string","description":"Name of the Azure AD tenant"},"syncEnabled":{"type":"boolean","description":"Specifies whether synchronizing users and groups for the Azure AD tenant is enabled or not."},"syncIntervalSeconds":{"type":"integer","description":"If syncEnabled is true, this interval specifies how often to synchronize Azure AD tenant users and groups, in seconds.","format":"int32"}},"discriminator":{"propertyName":"tenantType"}},"RoleItemPermissionResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the role","format":"uuid"},"name":{"type":"string","description":"Name of the role"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}},"description":"Role permissions granted for this item"},"ItemPermissionPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ItemPermissionResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"S3SubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"bucket":{"type":"string","description":"The name of the Amazon Web Services (AWS) S3 Bucket to which you want to upload"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"encryption":{"type":"string","description":"Whether to enable Amazon Web Services (AWS) S3 Server-Side Encryption. When enabled, S3 encrypts your data using AES-256 encryption mode.","enum":["none","sse"]},"permission":{"type":"string","description":"The predefined set of grantees and permissions to store with each uploaded object","enum":["privatePermission","publicRead","publicWrite","authRead","bucketRead","bucketFull"]},"version":{"type":"string","description":"Whether to enable versioning for the specified Amazon Web Services (AWS) S3 Bucket. To maintain the current behavior, or if you do not have permission to set S3 Bucket versioning, leave as \"Default\".","enum":["yes","no","defaultVersioning"]},"localSourcePath":{"type":"string","description":"The path to the file/folder to be uploaded. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The location in the specified Amazon Web Services (AWS) S3 Bucket to upload objects to, using forward slashes (/). If left blank, objects are uploaded to the S3 Bucket’s root."}}},"UpdateDataStreamingRequest":{"required":["registered","writers"],"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"reader":{"type":"string","description":"Reader to replace with HTTP body or internet download"},"writers":{"type":"array","description":"Writers to include in Data Streaming","items":{"type":"string","description":"Writers to include in Data Streaming"}}},"description":"Data Streaming service properties"},"JsonNode":{"type":"object"},"DataVirtualizationApiSecurityRequest":{"required":["requireAuthentication"],"type":"object","properties":{"requireAuthentication":{"type":"boolean","description":"Whether the API requires user authentication to access endpoints"},"allowedUsers":{"uniqueItems":true,"type":"array","description":"IDs of users that are authorized to run endpoints in this API","items":{"type":"string","description":"IDs of users that are authorized to run endpoints in this API","format":"uuid"}},"allowedRoles":{"uniqueItems":true,"type":"array","description":"IDs of roles that are authorized to run endpoints in this API","items":{"type":"string","description":"IDs of roles that are authorized to run endpoints in this API","format":"uuid"}}},"description":"Security configuration for the API"},"BatchDeleteProjectItemRequest":{"required":["items"],"type":"object","properties":{"items":{"type":"array","description":"List of the item types and IDs to be deleted","items":{"$ref":"#/components/schemas/DeleteProjectItemRequest"}}}},"SqsPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"queueUrl":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to pull messages from"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"deleteMessageAfterReceived":{"type":"boolean","description":"Whether to automatically delete the message after it has been received"},"visibilityTimeout":{"type":"integer","description":"The visibility timeout (in seconds) for the Amazon Web Services (AWS) SQS Queue","format":"int32"}}},"UpdateDatabaseConnectionRequest":{"required":["category","parameters"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateConnectionRequest"},{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters for the database connection"},"description":"The parameters for the database connection"}}}]},"DeploymentParameterTextResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/DeploymentParameterResponse"}]},"NewActivePeriodRequest":{"required":["description","endTime","name","recurrence","startTime"],"type":"object","properties":{"name":{"type":"string","description":"Name of active period"},"description":{"type":"string","description":"Description of active period"},"startDate":{"type":"string","description":"Start date of active period","format":"date-time"},"endDate":{"type":"string","description":"End date of active period","format":"date-time"},"startTime":{"type":"string","description":"Start time of active period","format":"date-time"},"endTime":{"type":"string","description":"End time of active period","format":"date-time"},"recurrence":{"type":"string","description":"Recurrence configuration of active period"},"engineRules":{"type":"array","description":"Engine rules to assign to the active period","items":{"type":"string","description":"Engine rules to assign to the active period","format":"uuid"}}}},"NewTokenResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the token","format":"uuid"},"name":{"type":"string","description":"Name of the token"},"description":{"type":"string","description":"Description of the token"},"ownerID":{"type":"string","description":"UUID of the user that owns the token","format":"uuid"},"owner":{"type":"string","description":"Name of the user that owns the token"},"type":{"type":"string","description":"Token type","enum":["api","session"]},"customPermissions":{"type":"boolean","description":"Whether the token has custom permissions; if false, the token has the same permissions as the token owner"},"enabled":{"type":"boolean","description":"Whether the token is enabled or not"},"created":{"type":"string","description":"Date/time when the token was created","format":"date-time"},"updated":{"type":"string","description":"Date/time when the token was last updated","format":"date-time"},"secondsToExpiry":{"type":"integer","description":"Seconds until the token expires","format":"int64"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format with timezone 'Z' for zero UTC offset","format":"date-time"},"token":{"type":"string","description":"The generated token"}}},"ImportResponse":{"type":"object","properties":{"jobID":{"type":"integer","description":"The unique identifier for the import","format":"int64"},"status":{"type":"string","description":"The status of the import","enum":["generatingPreview","ready","importing","imported","failed"]},"owner":{"type":"string","description":"The username of the user who requested the import"},"ownerID":{"type":"string","description":"The id of the user who requested the import"},"requested":{"type":"string","description":"When the import was requested","format":"date-time"},"generated":{"type":"string","description":"Completion time, if any, of preview generation","format":"date-time"},"fileName":{"type":"string","description":"The filename of the import"},"request":{"$ref":"#/components/schemas/ImportSettingsRequest"}},"description":"Items in this results page"},"DeploymentParameterResponse":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the parameter"},"value":{"type":"string","description":"Value assigned to the parameter"},"type":{"type":"string","description":"The type of the parameter","enum":["text","dropdown","password"]},"owner":{"type":"string","description":"The user who created the parameter"},"updated":{"type":"string","description":"When the parameter was last modified","format":"date-time"},"resourceMissing":{"type":"boolean","description":"Indicates if the resource assigned to the parameter cannot be found on FME Flow"}},"description":"Items in this results page","discriminator":{"propertyName":"type"}},"ProjectItemsPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ProjectItemResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdateItemOwnerRequest":{"required":["ownerID"],"type":"object","properties":{"ownerID":{"type":"string","description":"UUID of the owner","format":"uuid"}}},"ActivePeriodEngineRuleAssignmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the engine rule","format":"uuid"},"name":{"type":"string","description":"Name of the engine rule"}},"description":"Engine rules assigned to the active period"},"UpdateDirWatchPublicationRequest":{"required":["directory","eventsToWatchFor","pollInterval","publisherName","watchFolder","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"directory":{"type":"string","description":"The directory to watch for activity"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"watchFolder":{"type":"boolean","description":"Whether to monitor activities on only files or both files and folders"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified Directory to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear.","format":"int32"}}}]},"TestExistingLoggerSubscriptionRequest":{"required":["logLevel","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"logLevel":{"type":"string","description":"The level of detail of the notification message in the log file","enum":["low","normal","high"]}}}]},"DataVirtualizationTagResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the tag","format":"uuid"},"name":{"type":"string","description":"Name of the tag"},"description":{"type":"string","description":"Description of the tag"},"endpoints":{"type":"array","description":"Endpoints associated with the tag","items":{"$ref":"#/components/schemas/DataVirtualizationTagEndpointResponse"}}},"description":"Items in this results page"},"EngineHostResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the engine host"},"description":{"type":"string","description":"Description of the engine host"}},"description":"Items in this results page"},"JobMetricsAvgResponse":{"type":"object","properties":{"averageElapsedTime":{"type":"integer","description":"Average elapsed time","format":"int64"},"averageCpuTime":{"type":"integer","description":"Average CPU time","format":"int64"},"averagePeakMemoryUsage":{"type":"integer","description":"Average peak memory usage","format":"int64"},"totalRuns":{"type":"integer","description":"Total number of jobs","format":"int64"},"averageCpuPercent":{"type":"number","description":"Average CPU percentage","format":"double"}}},"LdapServerConnectionOptionsUpdateRequest":{"required":["searchUser"],"type":"object","properties":{"searchUser":{"type":"string","description":"Distinguished name of service account used for searches"},"searchUserPassword":{"type":"string","description":"Password of service account used for searches. If null, existing password will be preserved. If non-null, must also be non-empty."},"redundantServers":{"uniqueItems":true,"type":"array","description":"Additional LDAP servers used for maintaining high availability.","items":{"$ref":"#/components/schemas/RedundantServerRequest"}}},"description":"LDAP server connection options"},"DropboxWatchPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"path":{"type":"string","description":"The location on your Dropbox account to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}},"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"}}},"AccountPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/AccountResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"JobSubmitter":{"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"reader":{"type":"string","description":"Reader to replace with HTTP body or internet download"},"successTopics":{"type":"array","description":"Topics to notify on success","items":{"type":"string","description":"Topics to notify on success"}},"failureTopics":{"type":"array","description":"Topics to notify on failure","items":{"type":"string","description":"Topics to notify on failure"}},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Properties for the service"},"description":"Properties for the service"}},"description":"Job Submitter service properties"},"EntraIDSecondaryTenantResponse":{"type":"object","properties":{"tenantID":{"type":"string","description":"Directory (tenant) ID","format":"uuid"},"name":{"type":"string","description":"Name of the Azure AD tenant"},"tenantType":{"type":"string","description":"Indicates whether the tenant is primary or secondary","enum":["primary","secondary"]},"lastSync":{"type":"string","description":"Date/time when the active directory was last synchronized","format":"date-time"},"syncEnabled":{"type":"boolean","description":"Specifies whether synchronizing users and groups for the Azure AD tenant is enabled or not."},"syncIntervalSeconds":{"type":"integer","description":"If syncEnabled is true, this interval specifies how often to synchronize Azure AD tenant users and groups, in seconds.","format":"int32"}}},"EventGridSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"topicEndpoint":{"type":"string","description":"The topic endpoint of the Azure Event Grid Topic"},"topicKey":{"type":"string","description":"The topic access key used to publish events to the Azure Event Grid Topic"},"subject":{"type":"string","description":"The subject used for filtering and routing events"},"eventType":{"type":"string","description":"The event type of the specified subject"},"data":{"type":"string","description":"The event data, specified in key/value pairs, that is published to the specified Azure Event Grid Topic Endpoint."}}},"PublicationSummaryResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}}},"description":"Items in this results page"},"LdapServerObjectClassesRequest":{"required":["groupClass","userClass"],"type":"object","properties":{"userClass":{"type":"string","description":"Object class to be used when searching for users"},"groupClass":{"type":"string","description":"Object class to be used when searching for groups"}},"description":"Object classes used for user and group searches"},"NewDirectoryRequest":{"required":["directoryName","path"],"type":"object","properties":{"directoryName":{"type":"string","description":"Name of the directory to create."},"path":{"type":"string","description":"Path, relative to the resource connection (for example, /foo/bar/test.file)."}}},"SharedResourceResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the resource connection"},"owner":{"type":"string","description":"Owner of the resource connection"},"ownerID":{"type":"string","description":"UUID of the user that owns the resource connection","format":"uuid"},"shareable":{"type":"boolean","description":"Whether the resource connection is shareable or not"},"displayName":{"type":"string","description":"Display name of the resource connection"},"description":{"type":"string","description":"Description of the resource connection"},"migratable":{"type":"boolean","description":"Indicates if the resource files and folders is migrated during an FME Flow backup and restore operation. Either \"true\" or \"false\". It is recommended that AWS_S3 and NETWORK resources be set to not migratable."},"type":{"type":"string","description":"Type of the resource connection","enum":["file","awsS3","network"]},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Resource type-specific properties. Sensitive properties will be excluded from the response."},"description":"Resource type-specific properties. Sensitive properties will be excluded from the response."},"updatable":{"type":"boolean","description":"Whether the resource connection is updatable or not"}},"description":"Items in this results page"},"NewQueueRequest":{"required":["name","priority"],"type":"object","properties":{"name":{"type":"string","description":"Name of the queue"},"description":{"type":"string","description":"Description of the queue"},"priority":{"maximum":10,"minimum":1,"type":"integer","description":"Priority of the queue. Priority must be between 1 to 10, where 10 is the highest priority. Queues with higher priority will submit jobs to run first.","format":"int32"}}},"DataVirtualizationEndpointJobExpiryRequest":{"required":["inheritJobExpiry"],"type":"object","properties":{"inheritJobExpiry":{"type":"boolean","description":"Whether the endpoint will inherit the job expiry configuration of the API"},"jobExpiryInSeconds":{"type":"integer","description":"Job expiry in seconds. If inheritJobExpiry is false, jobExpiryInSeconds must be specified.","format":"int64"}}},"UpdatePasswordReuseCheckRequest":{"required":["enabled","numPasswordsIneligibleForReuse"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether password reuse checks are performed when a user attempts to change their password"},"numPasswordsIneligibleForReuse":{"maximum":10,"type":"integer","description":"Number of recently used passwords which a new password must differ from","format":"int32"}}},"NewTokenRequest":{"required":["customPermissions","enabled","name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the token"},"description":{"type":"string","description":"Description of the token"},"ownerID":{"type":"string","description":"UUID of the user that owns the token. If not supplied, then the current user will own the token.","format":"uuid"},"enabled":{"type":"boolean","description":"Whether the token is enabled or not"},"customPermissions":{"type":"boolean","description":"Whether the token has custom permissions; if false, the token has the same permissions as the token owner"},"secondsToExpiry":{"type":"integer","description":"Expiration timeout in seconds for the token. Either one of `secondsToExpiry` or `expiration` must be specified, but not both","format":"int64"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format (e.g., 2022-07-01T12:00-08:00). Either one of `secondsToExpiry` or `expiration` must be specified, but not both","format":"date-time"}}},"NewEmailSubscriptionRequest":{"required":["emailContentType","emailFrom","emailSubject","emailTo","name","smtpServer","smtpServerPort","smtpServerSecurity","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"smtpServer":{"type":"string","description":"The mail exchange server domain name or IP address"},"smtpServerPort":{"type":"integer","description":"The mail exchange TCP port","format":"int32","example":25},"smtpServerAccount":{"type":"string","description":"The username when SMTP server requires authentication"},"smtpServerPassword":{"type":"string","description":"The user or app password when SMTP server requires authentication"},"smtpServerSecurity":{"type":"string","description":"The encryption mechanism used for the connection","enum":["sslTls","startTls","none"]},"emailTo":{"type":"array","description":"The Email recipient(s)","items":{"type":"string","description":"The Email recipient(s)"}},"emailCc":{"type":"array","description":"The Email cc recipient(s)","items":{"type":"string","description":"The Email cc recipient(s)"}},"emailBcc":{"type":"array","description":"The Email bcc recipient(s)","items":{"type":"string","description":"The Email bcc recipient(s)"}},"emailFrom":{"type":"string","description":"The \"From\" field in standard Email messages. If users reply to the notification email, it is directed to this address."},"emailSubject":{"type":"string","description":"The subject of the Email"},"emailContentType":{"type":"string","description":"The format of the Email","enum":["text","html","richText"]},"emailAttachment":{"type":"array","description":"The path to the source file to attach to the Email","items":{"type":"string","description":"The path to the source file to attach to the Email"}},"emailTemplate":{"type":"string","description":"The message body to use for delivery. See documentation for supported tags."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"DeploymentParameterDropdownResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/DeploymentParameterResponse"},{"type":"object","properties":{"choiceSettings":{"$ref":"#/components/schemas/ChoiceSettings"}}}]},"JobResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this job","format":"int64"},"engineHost":{"type":"string","description":"The host of the engine that ran this job"},"engineName":{"type":"string","description":"The name of the engine that ran this job"},"repository":{"type":"string","description":"The repository of the workspace that was run"},"directives":{"type":"object","additionalProperties":{"type":"string","description":"Additional NM Directives, which can include client-configured keys, to pass to the notification service for custom use by subscriptions"},"description":"Additional NM Directives, which can include client-configured keys, to pass to the notification service for custom use by subscriptions"},"failureTopics":{"type":"array","description":"Topics to notify when the job fails","items":{"type":"string","description":"Topics to notify when the job fails"}},"successTopics":{"type":"array","description":"Topics to notify when the job succeeds","items":{"type":"string","description":"Topics to notify when the job succeeds"}},"maxJobRuntime":{"type":"integer","description":"Time (in seconds) elapsed for a running job before it's cancelled","format":"int64"},"maxTimeInQueue":{"type":"integer","description":"Time to live in the job queue (in seconds)","format":"int64"},"queue":{"type":"string","description":"The queue where job was routed to"},"queueType":{"type":"string","description":"The type of queue where job was routed to","enum":["system","remote"]},"publishedParameters":{"type":"object","additionalProperties":{"type":"object","description":"Published parameters passed to the job request"},"description":"Published parameters passed to the job request"},"deploymentParameters":{"type":"object","additionalProperties":{"type":"string","description":"Deployment parameters passed to the job request"},"description":"Deployment parameters passed to the job request"},"featureOutputCount":{"type":"integer","description":"Number of features output by this job","format":"int64"},"requesterHost":{"type":"string","description":"The host of the requester of this job"},"requesterResultPort":{"type":"integer","description":"The result port of the requester of this job","format":"int32"},"resultDatasetDownloadUrl":{"type":"string","description":"Download url for the result dataset of the job. This field only applies for jobs submitted to the Data Download Service."},"statusMessage":{"type":"string","description":"The status message of this job"},"sourceID":{"type":"string","description":"The id of the source that ran this job"},"sourceName":{"type":"string","description":"The name of the source that ran this job"},"sourceType":{"$ref":"#/components/schemas/SourceType"},"status":{"type":"string","description":"The current status of this job","enum":["queued","running","success","failure","cancelled"]},"timeFinished":{"type":"string","description":"The date this job was completed","format":"date-time"},"timeQueued":{"type":"string","description":"The date this job was queued","format":"date-time"},"timeStarted":{"type":"string","description":"The date this job was started","format":"date-time"},"runtimeUsername":{"type":"string","description":"The username of the FME Flow user that ran the job. When a job runs in the context of these FME Flow mechanisms, `runtimeUsername` means the following:\n* Automation (no manual trigger): The user that last enabled the automation to run the job.\n* Automation (with manual trigger): The user that manually triggered the automation to run the job.\n* Automation Schedule (no manual trigger): The user that last enabled the automation to run the job.\n* Automation Schedule (with manual trigger): The user that manually triggered the automation schedule to run the job.\n* FME Flow Web Services: The user that ran the job.\n* Schedule: (no manual trigger): The user that last updated the schedule.\n* Schedule: (with manual trigger): The user who manually triggered the schedule to run the job.\n* Stream: The user who last updated the stream's repository/workspace attributes or enabled the stream.\n* Workspace App (no authentication required): The user that owns the security token that is used to run the job from the app.\n* Workspace App (authentication required): The user that authenticated to run the job through the app.\n* Automation App: The user that authenticated to run the job through the app.\n* Webhook URL: The user that owns the security token for the webhook URL.\n* Run Workspace with FMEFlowJobSubmitter transformer: The user account that authenticates the FME Flow connection in the transformer.\n* Data Virtualization (no authentication required): The user that owns the Data Virtualization API.\n* Data Virtualization (authentication required): The user that owns the security token that is used to call the Data Virtualization endpoint."},"runtimeUserID":{"type":"string","description":"If specified, only jobs run by the specified user will be returned. When a job runs in the context of these FME Flow mechanisms, `runtimeUserID` means the following:\n* Automation (no manual trigger): The user that last enabled the automation to run the job.\n* Automation (with manual trigger): The user that manually triggered the automation to run the job.\n* Automation Schedule (no manual trigger): The user that last enabled the automation to run the job.\n* Automation Schedule (with manual trigger): The user that manually triggered the automation schedule to run the job.\n* FME Flow Web Services: The user that ran the job.\n* Schedule: (no manual trigger): The user that last updated the schedule.\n* Schedule: (with manual trigger): The user who manually triggered the schedule to run the job.\n* Stream: The user who last updated the stream's repository/workspace attributes or enabled the stream.\n* Workspace App (no authentication required): The user that owns the security token that is used to run the job from the app.\n* Workspace App (authentication required): The user that authenticated to run the job through the app.\n* Automation App: The user that authenticated to run the job through the app.\n* Webhook URL: The user that owns the security token for the webhook URL.\n* Run Workspace with FMEFlowJobSubmitter transformer: The user account that authenticates the FME Flow connection in the transformer.\n* Data Virtualization (no authentication required): The user that owns the Data Virtualization API.\n* Data Virtualization (authentication required): The user that owns the security token that is used to call the Data Virtualization endpoint.","format":"uuid"},"workspace":{"type":"string","description":"The name of the workspace that was run"},"elapsedTime":{"type":"integer","description":"The elapsed time in milliseconds of this job","format":"int64"},"cpuTime":{"type":"integer","description":"The CPU time in milliseconds of this job","format":"int64"},"cpuPercent":{"type":"number","description":"The CPU percent of this job","format":"double"},"peakMemoryUsage":{"type":"integer","description":"The peak memory usage in kilobytes of this job","format":"int64"},"lineCount":{"type":"integer","description":"The number of lines in the log file for this job","format":"int64"},"warningCount":{"type":"integer","description":"The number of warnings in the log file for this job","format":"int64"},"errorCount":{"type":"integer","description":"The number of errors in the log file for this job","format":"int64"},"remoteEngineName":{"type":"string","description":"The name of the remote engine that ran this job"},"remoteEngineJobLogUrl":{"type":"string","description":"The job log url of the remote engine that ran this job"}}},"CleanupConfigurationResponse":{"type":"object","properties":{"criticalMinimumDiskPercent":{"type":"integer","description":"The minimum free disk space size, in percentage, for a critical level cleanup event","format":"int32"},"criticalMinimumDiskSpace":{"type":"integer","description":"The minimum free disk space size, in gigabytes, for a critical level cleanup event","format":"int32"},"criticalNotificationTopic":{"type":"string","description":"The Notification Service topic to notify when critical level minimum free disk space criteria are met"},"criticalOperation":{"type":"string","description":"For a critical level cleanup event to be triggered, the free disk space percentage and/or the free disk space size in gigabytes must be below their respective critical thresholds. This value determines if both the disk space percentage and disk space size must be met (`and`), or if meeting either criterion is sufficient (`or`).","enum":["and","or"]},"taskInterval":{"type":"integer","description":"The frequency, in seconds, in which cleanup tasks are executed","format":"int64"},"warningMinimumDiskPercent":{"type":"integer","description":"The minimum free disk space size, in percentage, for a warning level cleanup event","format":"int32"},"warningMinimumDiskSpace":{"type":"integer","description":"The minimum free disk space size, in gigabytes, for a warning level cleanup event","format":"int32"},"warningNotificationTopic":{"type":"string","description":"The Notification Service topic to notify when warning level minimum free disk space criteria are met"},"warningOperation":{"type":"string","description":"For a warning level cleanup event to be triggered, the free disk space percentage and/or the free disk space size in gigabytes must be below their respective warning thresholds. This value determines if both the disk space percentage and disk space size must be met (`and`), or if meeting either criterion is sufficient (`or`).","enum":["and","or"]},"watchInterval":{"type":"integer","description":"The frequency, in seconds, in which system source paths are checked to ensure minimum free disk space criteria are met","format":"int64"}}},"NotificationOptions":{"type":"object","properties":{"type":{"type":"string","enum":["topic"]},"successTopic":{"type":"string"},"failureTopic":{"type":"string"}}},"UpdateRoleRequest":{"type":"object","properties":{"accounts":{"uniqueItems":true,"type":"array","description":"Accounts to assign to the role.","items":{"type":"string","description":"Accounts to assign to the role.","format":"uuid"}}}},"UpdateS3WatchPublicationRequest":{"required":["accessKeyID","bucket","eventsToWatchFor","pollInterval","publisherName","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The Bucket name in the Amazon Web Services (AWS) S3 account, case-sensitive"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"path":{"type":"string","description":"The folder location in the specified Amazon Web Services (AWS) S3 Bucket to watch for changes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified Amazon Web Services (AWS) S3 Bucket. S3 is a pay-per-use service. Every poll is one request to this service.","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"DataVirtualizationEndpointCachingRequest":{"required":["inheritCaching"],"type":"object","properties":{"inheritCaching":{"type":"boolean","description":"Whether the endpoint will inherit the caching configuration of the API"},"cacheEnabled":{"type":"boolean","description":"Whether caching is enabled. If inheritCaching is false, cacheEnabled must be specified."},"cacheExpiryInSeconds":{"type":"integer","description":"Cache expiry in seconds. If inheritCaching is false, cacheExpiryInSeconds must be specified.","format":"int64"}}},"LdapServerObjectClassesResponse":{"type":"object","properties":{"userClass":{"type":"string","description":"Object class to be used when searching for users"},"groupClass":{"type":"string","description":"Object class to be used when searching for groups"}},"description":"Object classes used for user and group searches"},"NewGenericLdapServerRequest":{"required":["authentication","connectionOptions","encryption","host","lookupAttributes","name","port","searchObjectClasses"],"type":"object","properties":{"name":{"type":"string","description":"Name of the LDAP server"},"host":{"type":"string","description":"LDAP server host"},"port":{"type":"integer","description":"LDAP server port","format":"int32"},"encryption":{"type":"string","description":"Encryption mode","enum":["none","ssl","startTls"]},"connectionOptions":{"$ref":"#/components/schemas/LdapServerConnectionOptionsRequest"},"authentication":{"type":"string","description":"Authentication mechanism","enum":["basic","sasl","sso"]},"saslAuthenticationProperties":{"$ref":"#/components/schemas/SaslAuthenticationPropertiesRequest"},"searchProperties":{"$ref":"#/components/schemas/SearchPropertiesRequest"},"syncOptions":{"$ref":"#/components/schemas/SyncOptionsRequest"},"lookupAttributes":{"$ref":"#/components/schemas/GenericLookupAttributesRequest"},"searchObjectClasses":{"$ref":"#/components/schemas/LdapServerObjectClassesRequest"}}},"AccountEnableRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled/Disabled state of the user account"}}},"MigrationTaskResponse":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the migration task.","format":"int64"},"type":{"type":"string","description":"Type of migration task.","enum":["systemRestore","systemBackup"]},"username":{"type":"string","description":"Username of user who triggered task."},"userID":{"type":"string","description":"ID of user who triggered task.","format":"uuid"},"startDate":{"type":"string","description":"Start date of task.","format":"date-time"},"finishedDate":{"type":"string","description":"Finish date of task.","format":"date-time"},"status":{"type":"string","description":"Status of task.","enum":["submitted","running","success","failure"]},"successTopic":{"type":"string","description":"Topic to notify on success."},"failureTopic":{"type":"string","description":"Topic to notify on failure."},"resourceName":{"type":"string","description":"Resource connection containing the package."},"packagePath":{"type":"string","description":"Path of the package, relative to the resource connection."},"packageName":{"type":"string","description":"Name of the package."},"importMode":{"type":"string","description":"The import mode for the files in the project.","enum":["overwrite","insert"]},"pauseNotifications":{"type":"boolean","description":"Disable notifications for the duration of the system restore."},"result":{"type":"string","description":"Result of the migration task."}},"description":"Items in this results page"},"Property":{"type":"object","properties":{"attributes":{"type":"object","additionalProperties":{"type":"string","description":"Attributes of this property. Keys are attribute names, values are attribute values"},"description":"Attributes of this property. Keys are attribute names, values are attribute values"},"category":{"type":"string","description":"The name of the category to which this property belongs"},"name":{"type":"string","description":"Property name"},"value":{"type":"string","description":"Property value"}},"description":"Properties defined for this dataset"},"UpdateWorkspaceSubscriptionRequest":{"required":["repository","subscriberName","workspace"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"repository":{"type":"string","description":"The repository in which the Workspace resides"},"workspace":{"type":"string","description":"The Workspace to subscribe to"},"queue":{"type":"string","description":"The queue in which to run the job"},"maxTimeInQueue":{"type":"integer","description":"The length of time after which a job that is waiting in queue does not execute","format":"int32"},"maxJobRuntime":{"minimum":1,"type":"integer","description":"The time a job will remain in the running state","format":"int32"},"runUntilCancelled":{"type":"boolean","description":"Whether to run the job continuously forever, until explicitly cancelled"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"publishedReaderOverride":{"type":"string","description":"The source dataset published parameter"},"publishedWriterForNotification":{"type":"string","description":"The destination dataset published parameter"}}}]},"EnablePasswordReuseCheckRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether password reuse checks are performed when a user attempts to change their password"}}},"UpdateSystemEmailPropsRequest":{"required":["connectionSecurity","emailFrom","smtpServer","smtpServerPort"],"type":"object","properties":{"smtpServer":{"type":"string","description":"Mail exchange server domain name or IP address used for sending email."},"smtpServerPort":{"type":"integer","description":"Mail exchange TCP port used for sending email.","format":"int32"},"connectionSecurity":{"type":"string","description":"The encryption mechanism used for the connection.","enum":["sslTls","startTls","none"]},"emailFrom":{"type":"string","description":"Corresponds to the From field in standard email messages. If users reply to the notification email message, it is directed to this email address."},"smtpAccount":{"type":"string","description":"If the SMTP server requires authentication, this is the user name."},"smtpPassword":{"type":"string","description":"If the SMTP server requires authentication, this is the user or app password."},"clientID":{"type":"string","description":"The Microsoft OAuth client ID, if applicable."}}},"Dataset":{"type":"object","properties":{"featureTypes":{"type":"array","description":"FME feature types belonging to this dataset","items":{"$ref":"#/components/schemas/FeatureType"}},"format":{"type":"string","description":"The format of the dataset"},"location":{"type":"string","description":"The location for the dataset"},"name":{"type":"string","description":"Unique name of the dataset"},"properties":{"type":"array","description":"Properties defined for this dataset","items":{"$ref":"#/components/schemas/Property"}},"source":{"type":"boolean","description":"If the dataset is a source dataset"}},"description":"The list of destination datasets"},"RoleResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the role","format":"uuid"},"name":{"type":"string","description":"Name of the role"},"accounts":{"type":"array","description":"Roles assigned to the account","items":{"$ref":"#/components/schemas/RoleAccountAssignmentResponse"}},"type":{"type":"string","description":"Type of the role","enum":["system","ldap","azure"]}}},"WorkspaceSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"repository":{"type":"string","description":"The repository in which the Workspace resides"},"workspace":{"type":"string","description":"The Workspace to subscribe to"},"queue":{"type":"string","description":"The queue in which to run the job"},"maxTimeInQueue":{"type":"integer","description":"The length of time after which a job that is waiting in queue does not execute","format":"int32"},"maxJobRuntime":{"type":"integer","description":"The time a job will remain in the running state","format":"int32"},"runUntilCancelled":{"type":"boolean","description":"Whether to run the job continuously forever, until explicitly cancelled"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"publishedReaderOverride":{"type":"string","description":"The source dataset published parameter"},"publishedWriterForNotification":{"type":"string","description":"The destination dataset published parameter"}}},"AppStylingResponse":{"type":"object","properties":{"hasHeadingLogo":{"type":"boolean","description":"Whether the app has a heading logo"},"hasHeadingBanner":{"type":"boolean","description":"Whether the app has a heading banner"},"hasFooterLogo":{"type":"boolean","description":"Whether the app has a footer logo"},"hasFooterBanner":{"type":"boolean","description":"Whether the app has a footer banner"},"hasIcon":{"type":"boolean","description":"Whether the app has an icon"},"browserTitle":{"type":"string","description":"Browser title"},"footerText":{"type":"string","description":"Footer text"},"backgroundColor":{"type":"string","description":"Background color"}},"description":"Styling for the app"},"EngineScaleRequest":{"required":["engineCount","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of FME Engine to scale.","enum":["standard","dynamic"]},"engineCount":{"type":"integer","description":"Number of FME Engines","format":"int32"}}},"UpdateRepositoryRequest":{"type":"object","properties":{"description":{"type":"string","description":"Description of the repository."}}},"S3WatchPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"bucket":{"type":"string","description":"The Bucket name in the Amazon Web Services (AWS) S3 account, case-sensitive"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"path":{"type":"string","description":"The folder location in the specified Amazon Web Services (AWS) S3 Bucket to watch for changes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified Amazon Web Services (AWS) S3 Bucket. S3 is a pay-per-use service. Every poll is one request to this service.","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}},"JobSummaryResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this job","format":"int64"},"description":{"type":"string","description":"Provided description for this job"},"engineHost":{"type":"string","description":"The host of the engine that ran this job"},"engineName":{"type":"string","description":"The name of the engine that ran this job"},"repository":{"type":"string","description":"The repository of the workspace that was run"},"queue":{"type":"string","description":"The queue where job was routed to"},"queueType":{"type":"string","description":"The type of queue where job was routed to","enum":["system","remote"]},"resultDatasetDownloadUrl":{"type":"string","description":"Download url for the result dataset of the job. This field only applies for jobs submitted to the Data Download Service."},"sourceID":{"type":"string","description":"The id of the source that ran this job"},"sourceName":{"type":"string","description":"The name of the source that ran this job"},"sourceType":{"$ref":"#/components/schemas/SourceType"},"status":{"type":"string","description":"The current status of this job","enum":["queued","running","success","failure","cancelled"]},"timeFinished":{"type":"string","description":"The date this job was completed","format":"date-time"},"timeQueued":{"type":"string","description":"The date this job was queued","format":"date-time"},"timeStarted":{"type":"string","description":"The date this job was started","format":"date-time"},"runtimeUsername":{"type":"string","description":"The username of the FME Flow user that ran the job. When a job runs in the context of these FME Flow mechanisms, `runtimeUsername` means the following:\n* Automation (no manual trigger): The user that last enabled the automation to run the job.\n* Automation (with manual trigger): The user that manually triggered the automation to run the job.\n* FME Flow Web Services: The user that ran the job.\n* Schedule: (no manual trigger): The user that last updated the schedule.\n* Schedule: (with manual trigger): The user who manually triggered the schedule to run the job.\n* Stream: The user who last updated the stream's repository/workspace attributes or enabled the stream.\n* Workspace App (no authentication required): The user that owns the security token that is used to run the job from the app.\n* Workspace App (authentication required): The user that authenticated to run the job through the app.\n* Automation App: The user that authenticated to run the job through the app.\n* Webhook URL: The user that owns the security token for the webhook URL.\n* Run Workspace with FMEFlowJobSubmitter transformer: The user account that authenticates the FME Flow connection in the transformer.\n* Data Virtualization (no authentication required): The user that owns the Data Virtualization API.\n* Data Virtualization (authentication required): The user that owns the security token that is used to call the Data Virtualization endpoint."},"runtimeUserID":{"type":"string","description":"If specified, only jobs run by the specified user will be returned. When a job runs in the context of these FME Flow mechanisms, `runtimeUserID` means the following:\n* Automation (no manual trigger): The user that last enabled the automation to run the job.\n* Automation (with manual trigger): The user that manually triggered the automation to run the job.\n* FME Flow Web Services: The user that ran the job.\n* Schedule: (no manual trigger): The user that last updated the schedule.\n* Schedule: (with manual trigger): The user who manually triggered the schedule to run the job.\n* Stream: The user who last updated the stream's repository/workspace attributes or enabled the stream.\n* Workspace App (no authentication required): The user that owns the security token that is used to run the job from the app.\n* Workspace App (authentication required): The user that authenticated to run the job through the app.\n* Automation App: The user that authenticated to run the job through the app.\n* Webhook URL: The user that owns the security token for the webhook URL.\n* Run Workspace with FMEFlowJobSubmitter transformer: The user account that authenticates the FME Flow connection in the transformer.\n* Data Virtualization (no authentication required): The user that owns the Data Virtualization API.\n* Data Virtualization (authentication required): The user that owns the security token that is used to call the Data Virtualization endpoint.","format":"uuid"},"workspace":{"type":"string","description":"The name of the workspace that was run"},"elapsedTime":{"type":"integer","description":"The elapsed time in milliseconds of this job","format":"int64"},"cpuTime":{"type":"integer","description":"The CPU time in milliseconds of this job","format":"int64"},"cpuPercent":{"type":"number","description":"The CPU percent of this job","format":"double"},"peakMemoryUsage":{"type":"integer","description":"The peak memory usage in kilobytes of this job","format":"int64"},"lineCount":{"type":"integer","description":"The number of lines in the log file for this job","format":"int64"},"warningCount":{"type":"integer","description":"The number of warnings in the log file for this job","format":"int64"},"errorCount":{"type":"integer","description":"The number of errors in the log file for this job","format":"int64"}},"description":"Items in this results page"},"DownloadFileRequest":{"required":["path"],"type":"object","properties":{"path":{"type":"string","description":"Path, relative to the resource connection (for example, /foo/bar/test.file)."},"disposition":{"type":"string","description":"Specifies how to retrieve the resource using the 'Content-Disposition' header.  This parameter is only relevant for some REST clients (primarily web browsers).  If no disposition is selected, then a header is not set.","enum":["inline","attachment"]}}},"DataVirtualizationEndpointUpdateResponseType":{"required":["endpointIDs","responseType"],"type":"object","properties":{"responseType":{"type":"string","description":"Specifies the response type the endpoints will be updated to","enum":["workspace","manual"]},"endpointIDs":{"uniqueItems":true,"type":"array","description":"Specifies the UUIDs (unique identifiers) of the endpoints to update","items":{"type":"string","description":"Specifies the UUIDs (unique identifiers) of the endpoints to update","format":"uuid"}}}},"UpdateStreamEngineRuleRequest":{"required":["enabled","name","queues","rule","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of engine assignment rule"},"type":{"type":"string","description":"Type of engine assignment rule","enum":["name","property"]},"rule":{"type":"string","description":"Engine assignment rule"},"queues":{"type":"array","description":"Queues to assign engines to","items":{"type":"string","description":"Queues to assign engines to"}},"enabled":{"type":"boolean","description":"Indicates if engine assignment rule is enabled"}}},"UpdateUdpPublicationRequest":{"required":["port","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"port":{"type":"integer","description":"The UDP port to listen to for incoming data packets","format":"int32"}}}]},"TestPublicationRequest":{"required":["publisherName"],"type":"object","properties":{"publisherName":{"type":"string","description":"The communication protocol used for the publication","enum":["sqs","dropboxwatch","dirwatch","eventgrid","sns","s3watch","ftpwatch","jms","smtp","websocket","udp","imap"]}},"discriminator":{"propertyName":"publisherName"}},"ScheduleResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the schedule","format":"uuid"},"name":{"type":"string","description":"Name of the schedule."},"enabled":{"type":"boolean","description":"Specifies whether the schedule is enabled or not."},"owner":{"type":"string","description":"Username of the owner of the schedule"},"ownerID":{"type":"string","description":"UUID of the owner of the schedule","format":"uuid"},"recurrence":{"type":"string","description":"Type of recurrence, either an interval or a CRON expression","enum":["cron","basic","interval","none"]},"cron":{"type":"string","description":"CRON expression (applies to 'cron' recurrence type)"},"begin":{"type":"string","description":"Date/time the schedule will begin"},"end":{"type":"string","description":"Date/time the schedule will end and no longer run"},"interval":{"type":"integer","description":"If `recurrence` is `interval`, the interval size, based on the specified `unit`","format":"int32"},"unit":{"type":"string","description":"If 'recurrence' is 'interval', the unit of interval","enum":["second","minute","hour","day","week","month","year"]},"description":{"type":"string","description":"Description of the schedule"},"skipUntilJobComplete":{"type":"boolean","description":"Option to prevent the schedule from triggering until the last triggered job is complete"},"repository":{"type":"string","description":"Repository containing the workspace to run"},"workspace":{"type":"string","description":"The workspace to run"},"lastTriggered":{"type":"string","description":"The date/time when the schedule was last triggered"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"tags":{"type":"array","description":"Tags associated with the schedule","items":{"type":"string","description":"Tags associated with the schedule"}},"shareable":{"type":"boolean","description":"Whether the schedule is shareable or not"},"lastUpdateUser":{"type":"string","description":"Username of the user who last updated the schedule"},"lastUpdateUserID":{"type":"string","description":"UUID of the user who last updated the schedule","format":"uuid"},"queue":{"type":"string","description":"The job routing queue"},"failureTopics":{"type":"array","description":"Topics to notify when the job fails","items":{"type":"string","description":"Topics to notify when the job fails"}},"successTopics":{"type":"array","description":"Topics to notify when the job succeeds","items":{"type":"string","description":"Topics to notify when the job succeeds"}},"maxJobRuntime":{"type":"integer","description":"Time (in seconds) elapsed for a running job before it's cancelled. The minimum value is 1 second.","format":"int64"},"maxTimeInQueue":{"type":"integer","description":"Time to live in the job queue (in seconds)","format":"int64"},"totalRuns":{"type":"integer","description":"Total number of jobs","format":"int64"},"averageCpuTime":{"type":"integer","description":"Average CPU time","format":"int64"},"averageCpuPercent":{"type":"number","description":"Average CPU percentage","format":"double"},"averageElapsedTime":{"type":"integer","description":"Average elapsed time","format":"int64"},"averagePeakMemoryUsage":{"type":"integer","description":"Average peak memory usage","format":"int64"},"logDebug":{"type":"boolean","description":"Whether the stream will run with debug logging or not"}}},"OAuthV2ConnectionResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the connection"},"category":{"type":"string","description":"The category of the connection","enum":["database","basic","token","oauthV2"]},"type":{"type":"string","description":"The type of the connection"},"owner":{"type":"string","description":"The owner of the connection"},"shareable":{"type":"boolean","description":"Whether the connection is shareable"},"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters associated with the connection"},"description":"The parameters associated with the connection"}}},"NewSubscriptionRequest":{"required":["name","subscriberName"],"type":"object","properties":{"name":{"type":"string","description":"Unique name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription","enum":["httprequest","sqs","logger","ftp","eventgrid","sns","workspace","dropbox","jms","sftp","s3","email","websocket"]},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}}},"discriminator":{"propertyName":"subscriberName"}},"DependencyResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the resource"},"id":{"type":"string","description":"The id of the resource"},"type":{"$ref":"#/components/schemas/ProjectItemType"},"dependencies":{"type":"array","description":"Dependencies of the resource","items":{"$ref":"#/components/schemas/DependencyResponse"}}},"description":"The dependencies of the item."},"TestSnsPublicationRequest":{"required":["publisherName","subscriptionArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"subscriptionArn":{"type":"string","description":"The Amazon Web Services (AWS) SNS Subscription ID"}}}]},"EnablePasswordResetRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether FME Flow password reset is enabled (true) or disabled (false)"}}},"SAMLConfigResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of SAML configuration","format":"uuid"},"name":{"type":"string","description":"Name of SAML configuration"},"signRequests":{"type":"boolean","description":"Whether the SAML response is encrypted."},"spKeyInstalled":{"type":"boolean","description":"Whether the service provider key is installed."},"spCertificateInstalled":{"type":"boolean","description":"Whether the service provider certificate is installed."},"useMetadataFile":{"type":"boolean","description":"Whether the identity provider metadata is used for configuration."},"metadataFileInstalled":{"type":"boolean","description":"Whether the identity provider metadata is installed."},"idpDetails":{"$ref":"#/components/schemas/IdentityProviderDetails"},"autoAddNewUsers":{"type":"boolean","description":"Whether new users are automatically added to FME Flow."},"defaultRole":{"type":"string","description":"The default role under which new users are added","format":"uuid"},"attributeMap":{"$ref":"#/components/schemas/AttributeMap"},"enabled":{"type":"boolean","description":"Whether the SAML configuration is enabled"},"lastUpdated":{"type":"string","description":"When the SAML configuration was last updated","format":"date-time"}},"description":"Items in this results page"},"NewConnectionRequest":{"required":["category","name","type"],"type":"object","properties":{"category":{"type":"string","description":"Category of the connection","enum":["database","basic","token","oauthV2"]},"name":{"type":"string","description":"Name of the connection"},"type":{"type":"string","description":"Type of the connection"}},"discriminator":{"propertyName":"category"}},"NewDropboxSubscriptionRequest":{"required":["accessToken","localSourcePath","name","remoteUploadDirectory","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"TestS3SubscriptionRequest":{"required":["accessKeyID","bucket","encryption","permission","secretAccessKey","subscriberName","version"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The name of the Amazon Web Services (AWS) S3 Bucket to which you want to upload"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"encryption":{"type":"string","description":"Whether to enable Amazon Web Services (AWS) S3 Server-Side Encryption. When enabled, S3 encrypts your data using AES-256 encryption mode.","enum":["none","sse"]},"permission":{"type":"string","description":"The predefined set of grantees and permissions to store with each uploaded object","enum":["privatePermission","publicRead","publicWrite","authRead","bucketRead","bucketFull"]},"version":{"type":"string","description":"Whether to enable versioning for the specified Amazon Web Services (AWS) S3 Bucket. To maintain the current behavior, or if you do not have permission to set S3 Bucket versioning, leave as \"Default\".","enum":["yes","no","defaultVersioning"]},"localSourcePath":{"type":"string","description":"The path to the file/folder to be uploaded. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The location in the specified Amazon Web Services (AWS) S3 Bucket to upload objects to, using forward slashes (/). If left blank, objects are uploaded to the S3 Bucket’s root."}}}]},"EngineRuleActivePeriodAssignmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the active period","format":"uuid"},"name":{"type":"string","description":"Name of the active period"},"active":{"type":"boolean","description":"Indicates if the active period is currently active"}},"description":"Engine rules assigned to the active period"},"Datasets":{"type":"object","properties":{"source":{"type":"array","description":"The list of source datasets","items":{"$ref":"#/components/schemas/Dataset"}},"destination":{"type":"array","description":"The list of destination datasets","items":{"$ref":"#/components/schemas/Dataset"}}},"description":"Source and destination datasets belonging to this workspace"},"UpdateStreamRequest":{"required":["enabled","name","repository","workspace"],"type":"object","properties":{"name":{"type":"string","description":"Display name of the stream"},"description":{"type":"string","description":"Description of the stream"},"enabled":{"type":"boolean","description":"Whether the stream is enabled or not"},"repository":{"type":"string","description":"The repository of the job to run"},"workspace":{"pattern":".*.(?i)fmw","type":"string","description":"The workspace of the job to run","example":"string"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"logDebug":{"type":"boolean","description":"Whether the stream will run with debug logging or not"},"remoteConfiguration":{"$ref":"#/components/schemas/StreamRemoteConfig"}}},"DataVirtualizationEndpointPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DataVirtualizationEndpointSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdatePasswordExistingRemoteEngineConnectionRequestSnowflake":{"required":["currentPassword","newPassword","snowflakeAuthentication","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePasswordExistingRemoteEngineConnectionRequest"},{"type":"object","properties":{"snowflakeAuthentication":{"$ref":"#/components/schemas/UpdateSnowflakeAuthRequest"}}}]},"SystemEmailPropsResponse":{"type":"object","properties":{"smtpServer":{"type":"string","description":"Mail exchange server domain name or IP address used for sending email."},"smtpServerPort":{"type":"integer","description":"Mail exchange TCP port used for sending email.","format":"int32"},"smtpAccount":{"type":"string","description":"If the SMTP server requires authentication, this is the user name."},"smtpPassword":{"type":"string","description":"If the SMTP server requires authentication, this is the password."},"connectionSecurity":{"type":"string","description":"The encryption mechanism used for the connection.","enum":["sslTls","startTls","none"]},"emailFrom":{"type":"string","description":"Corresponds to the From field in standard email messages. If users reply to the notification email message, it is directed to this email address."},"clientID":{"type":"string","description":"The Microsoft OAuth client ID, if applicable."}}},"UpdateWebSocketSubscriptionRequest":{"required":["streamID","subscriberName","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications."},"template":{"type":"string","description":"The message sent in the stream"}}}]},"UpdateServiceRegistrationRequest":{"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the workspace should be registered or unregistered."}}},"DataVirtualizationTagEndpointResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the endpoint","format":"uuid"},"path":{"type":"string","description":"Path of the endpoint"},"operation":{"type":"string","description":"Operation this endpoint will perform","enum":["get","post","put","delete"]}},"description":"Endpoints associated with the tag"},"CleanupSystemTaskPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/CleanupSystemTaskResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdateItemPermissionRequest":{"required":["category","name","permissions"],"type":"object","properties":{"category":{"type":"string","description":"Category of the item"},"name":{"type":"string","description":"Name of the item"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}}},"WebSocketSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"url":{"type":"string","description":"The URL of the WebSocket server"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications."},"template":{"type":"string","description":"The message sent in the stream"}}},"EnginesConfigResponse":{"type":"object","properties":{"maxQueueCount":{"type":"integer","description":"Maximum number of assigned queues per engine. Should be 1 or greater, otherwise -1 means unlimited.","format":"int32"},"maxJobRetries":{"type":"integer","description":"Maximum number of times a failed transaction request will be automatically resubmitted for processing,\nafter which the failed request is cancelled.\n\nA value of -1 means that no maximum limit is imposed, and failed transaction requests will be\nautomatically resubmitted indefinitely.\n\nA value of 0 means that automatic resubmission is disabled.","format":"int32"}}},"UpdateTokenRequest":{"required":["customPermissions","enabled"],"type":"object","properties":{"description":{"type":"string","description":"Description of the token"},"enabled":{"type":"boolean","description":"Whether the token is enabled or not"},"customPermissions":{"type":"boolean","description":"Whether the token has custom permissions; if false, the token has the same permissions as the token owner"},"secondsToExpiry":{"type":"integer","description":"Expiration timeout in seconds for the token. Either one of `secondsToExpiry` or `expiration` must be specified, but not both","format":"int64"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format (e.g., 2022-07-01T12:00-08:00). Either one of `secondsToExpiry` or `expiration` must be specified, but not both","format":"date-time"}}},"NewEntraIDPrimaryTenantRequest":{"required":["clientID","clientSecret","name","tenantID","tenantType"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewEntraIDTenantRequest"},{"type":"object","properties":{"clientID":{"type":"string","description":"Application (client) ID","format":"uuid"},"clientSecret":{"type":"string","description":"Client secret for the application"}}}]},"UpdateBasicConnectionRequest":{"required":["authenticationMethod","category"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateConnectionRequest"},{"type":"object","properties":{"authenticationMethod":{"type":"string","description":"The HTTP authentication method","enum":["basic","digest","ntlm","none"]},"username":{"type":"string","description":"The username for a basic connection"},"password":{"type":"string","description":"The password for a basic connection"}}}]},"WindowsLookupAttributesRequest":{"type":"object","properties":{"fullName":{"type":"string","description":"Attribute containing the full name of the LDAP user. When omitted, 'displayName' is used"},"email":{"type":"string","description":"Attribute containing the email address of the LDAP user"},"group":{"type":"string","description":"Attribute containing the name of the LDAP group. When omitted, 'sAMAccountName' is used"},"username":{"type":"string","description":"Attribute containing the name of the LDAP user. When omitted, 'sAMAccountName' is used"}},"description":"Attributes used to fetch user and group details"},"GenerateTokenResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the token on the Remote Engine","format":"uuid"},"name":{"type":"string","description":"Name of the token"},"secondsToExpiry":{"type":"integer","description":"Seconds until the token expires","format":"int64"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format with timezone 'Z' for zero UTC offset","format":"date-time"},"token":{"type":"string","description":"The generated token"}}},"TokenConnectionResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the connection"},"category":{"type":"string","description":"The category of the connection","enum":["database","basic","token","oauthV2"]},"type":{"type":"string","description":"The type of the connection"},"owner":{"type":"string","description":"The owner of the connection"},"shareable":{"type":"boolean","description":"Whether the connection is shareable"},"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters associated with the connection"},"description":"The parameters associated with the connection"}}},"StreamEngineInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Number of engines assigned to the stream","format":"int32"},"names":{"type":"array","description":"List of engine names assigned to the stream","items":{"type":"string","description":"List of engine names assigned to the stream"}}},"description":"Information about the engines assigned to the stream"},"UpdateQueueRequest":{"required":["priority"],"type":"object","properties":{"description":{"type":"string","description":"Description of the queue"},"priority":{"maximum":10,"minimum":1,"type":"integer","description":"Priority of the queue. Priority must be between 1 to 10, where 10 is the highest priority. Queues with higher priority will submit jobs to run first.","format":"int32"}}},"SubscriptionSummaryResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}}},"description":"Items in this results page"},"DataVirtualizationApiCachingResponse":{"type":"object","properties":{"cacheEnabled":{"type":"boolean","description":"Whether caching is enabled"},"cacheExpiryInSeconds":{"type":"integer","description":"Cache expiry in seconds","format":"int64"}},"description":"Caching configuration for the API"},"DatabaseConnectionPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DatabaseConnectionResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewEventGridPublicationRequest":{"required":["name","publisherName","webhookEndpoint"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"webhookEndpoint":{"type":"string","description":"The WebHook endpoint from which to receive events. The ID parameter acts as an access token to verify that the event is coming from Azure Event Grid and should be kept private. Azure Event Grid only supports publicly accessible HTTPS webhook endpoints using a valid certificate."}}}]},"SnsSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"topicArn":{"type":"string","description":"The ARN of the Amazon Web Services (AWS) SNS Topic"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SNS Topic"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SNS Topic"},"subject":{"type":"string","description":"The subject of the Amazon Web Services (AWS) SNS Topic"},"contentTemplate":{"type":"string","description":"The default message to publish to the Amazon Web Services (AWS) SNS Topic. Can be up to 64 KB of Unicode text."}}},"ProxyCredentialsRequest":{"type":"object","properties":{"username":{"type":"string","description":"The username used for proxy authentication"},"password":{"type":"string","description":"The password used for proxy authentication"},"authenticationMethod":{"type":"string","description":"The authentication method","enum":["basic","ntlm","digest"]}},"description":"The authentication credentials for the proxy"},"NewFtpWatchPublicationRequest":{"required":["connectionType","encryption","eventsToWatchFor","host","name","path","pollInterval","port","publisherName","verifyCertificate","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"path":{"type":"string","description":"The location on the FTP server to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified FTP server to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"EngineResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the engine"},"hostname":{"type":"string","description":"The hostname of the node the engine is running on"},"engineManagerHostname":{"type":"string","description":"The hostname of the FME Flow core node the engine is registered to"},"platform":{"type":"string","description":"The OS and platform"},"currentJobID":{"type":"integer","description":"The ID of the job the engine is currently running (null if none)","format":"int64"},"buildNumber":{"type":"integer","description":"The FME build number","format":"int32"},"type":{"type":"string","description":"The engine type (Dynamic, Standard)","enum":["standard","dynamic"]},"state":{"type":"string","description":"The engine state (Idle, Running Job, Disconnected)","enum":["idle","runningJob","disconnected"]},"assignedQueues":{"type":"array","description":"The queues assigned to the engine","items":{"type":"string","description":"The queues assigned to the engine"}}},"description":"Items in this results page"},"UpdateTopicRequest":{"type":"object","properties":{"description":{"type":"string","description":"Description of the topic"}}},"ExpirationRequest":{"required":["expiration"],"type":"object","properties":{"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format (e.g., 2022-07-01T12:00-08:00)","format":"date-time"}}},"PasswordExpirationResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether a password should expire after a specified number of days"},"daysUntilExpiration":{"type":"integer","description":"The number of days after which a password expires","format":"int64"}}},"EntraIDRolePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/EntraIDRoleResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdateSftpSubscriptionRequest":{"required":["host","port","remoteUploadDirectory","subscriberName","username","verifyHostKey"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The SFTP host name"},"port":{"type":"integer","description":"The SFTP port number","format":"int32","example":22},"username":{"type":"string","description":"The SFTP username for authentication"},"password":{"type":"string","description":"The SFTP user password for authentication"},"verifyHostKey":{"type":"boolean","description":"Whether to verify the host key for the server being connected to"},"knownHostsFile":{"type":"string","description":"The path to the known_hosts file that contains the public keys for any servers you wish to connect to, if verifying host key. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"localSourcePath":{"type":"string","description":"The source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file"}}}]},"UpdateProxyConfigRequest":{"required":["enabled","host","nonProxyHosts","port","requiresAuthentication","scheme"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the proxy is enabled or not"},"host":{"type":"string","description":"The proxy host"},"nonProxyHosts":{"type":"array","description":"The lists of hosts that will be accessed without without a proxy","items":{"type":"string","description":"The lists of hosts that will be accessed without without a proxy"}},"port":{"type":"integer","description":"The proxy port","format":"int32"},"scheme":{"type":"string","description":"The proxy scheme"},"requiresAuthentication":{"type":"boolean","description":"Whether the proxy requires authentication or not"},"credentials":{"$ref":"#/components/schemas/ProxyCredentialsRequest"}},"description":"Proxy configuration for the Remote Engine."},"TestExistingWorkspaceSubscriptionRequest":{"required":["repository","subscriberName","workspace"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"repository":{"type":"string","description":"The repository in which the Workspace resides"},"workspace":{"type":"string","description":"The Workspace to subscribe to"},"queue":{"type":"string","description":"The queue in which to run the job"},"maxTimeInQueue":{"type":"integer","description":"The length of time after which a job that is waiting in queue does not execute","format":"int32"},"maxJobRuntime":{"minimum":1,"type":"integer","description":"The time a job will remain in the running state","format":"int32"},"runUntilCancelled":{"type":"boolean","description":"Whether to run the job continuously forever, until explicitly cancelled"},"publishedParameters":{"type":"array","description":"The published parameters of the Workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"publishedReaderOverride":{"type":"string","description":"The source dataset published parameter"},"publishedWriterForNotification":{"type":"string","description":"The destination dataset published parameter"}}}]},"TestExistingSftpSubscriptionRequest":{"required":["host","port","remoteUploadDirectory","subscriberName","username","verifyHostKey"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The SFTP host name"},"port":{"type":"integer","description":"The SFTP port number","format":"int32","example":22},"username":{"type":"string","description":"The SFTP username for authentication"},"password":{"type":"string","description":"The SFTP user password for authentication"},"verifyHostKey":{"type":"boolean","description":"Whether to verify the host key for the server being connected to"},"knownHostsFile":{"type":"string","description":"The path to the known_hosts file that contains the public keys for any servers you wish to connect to, if verifying host key. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"localSourcePath":{"type":"string","description":"The source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file"}}}]},"EmailSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"smtpServer":{"type":"string","description":"The mail exchange server domain name or IP address"},"smtpServerPort":{"type":"integer","description":"The mail exchange TCP port","format":"int32"},"smtpServerAccount":{"type":"string","description":"The username when SMTP server requires authentication"},"smtpServerPassword":{"type":"string","description":"The user or app password when SMTP server requires authentication"},"smtpServerSecurity":{"type":"string","description":"The encryption mechanism used for the connection","enum":["sslTls","startTls","none"]},"emailTo":{"type":"array","description":"The Email recipient(s)","items":{"type":"string","description":"The Email recipient(s)"}},"emailCc":{"type":"array","description":"The Email cc recipient(s)","items":{"type":"string","description":"The Email cc recipient(s)"}},"emailBcc":{"type":"array","description":"The Email bcc recipient(s)","items":{"type":"string","description":"The Email bcc recipient(s)"}},"emailFrom":{"type":"string","description":"The \"From\" field in standard Email messages. If users reply to the notification email, it is directed to this address."},"emailSubject":{"type":"string","description":"The subject of the Email"},"emailContentType":{"type":"string","description":"The format of the Email","enum":["text","html","richText"]},"emailAttachment":{"type":"array","description":"The path to the source file to attach to the Email","items":{"type":"string","description":"The path to the source file to attach to the Email"}},"emailTemplate":{"type":"string","description":"The message body to use for delivery. See documentation for supported tags."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}},"UpdateSystemTaskRequest":{"required":["enabled","maxAgeInSeconds"],"type":"object","properties":{"maxAgeInSeconds":{"minimum":0,"type":"integer","description":"Maximum age (seconds) of files, jobs, system events, or tokens to keep before cleaning","format":"int64"},"enabled":{"type":"boolean","description":"Whether the cleanup task is currently enabled or disabled"}}},"DownloadItemsRequest":{"required":["items","zipFileName"],"type":"object","properties":{"items":{"type":"array","description":"List of up to 500 items to be downloaded.","items":{"type":"string","description":"List of up to 500 items to be downloaded."}},"zipFileName":{"type":"string","description":"Name of the downloaded zipped file."}}},"TestExistingS3SubscriptionRequest":{"required":["accessKeyID","bucket","encryption","permission","subscriberName","version"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The name of the Amazon Web Services (AWS) S3 Bucket to which you want to upload"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"encryption":{"type":"string","description":"Whether to enable Amazon Web Services (AWS) S3 Server-Side Encryption. When enabled, S3 encrypts your data using AES-256 encryption mode.","enum":["none","sse"]},"permission":{"type":"string","description":"The predefined set of grantees and permissions to store with each uploaded object","enum":["privatePermission","publicRead","publicWrite","authRead","bucketRead","bucketFull"]},"version":{"type":"string","description":"Whether to enable versioning for the specified Amazon Web Services (AWS) S3 Bucket. To maintain the current behavior, or if you do not have permission to set S3 Bucket versioning, leave as \"Default\".","enum":["yes","no","defaultVersioning"]},"localSourcePath":{"type":"string","description":"The path to the file/folder to be uploaded. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The location in the specified Amazon Web Services (AWS) S3 Bucket to upload objects to, using forward slashes (/). If left blank, objects are uploaded to the S3 Bucket’s root."}}}]},"MoveRequest":{"required":["destinationPath","items","path"],"type":"object","properties":{"path":{"type":"string","description":"Source directory relative to the resource connection from which to move items."},"items":{"type":"array","description":"List of up to 500 file or folder names to be moved.","items":{"type":"string","description":"List of up to 500 file or folder names to be moved."}},"destinationPath":{"type":"string","description":"Destination directory, relative to the same resource connection or another one specified, to move the items to."},"destinationResource":{"type":"string","description":"Name of the resource connection to receive the items. If not supplied, then the items are moved to the same resource connection."}}},"StreamPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/StreamSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"HealthCheckInitializationTask":{"type":"object","properties":{"task":{"type":"string","enum":["installDefaultContent"]},"status":{"type":"string","enum":["success","failure"]}},"description":"The status of each initialization task involved in the health check"},"UpdateConnectionRequest":{"required":["category"],"type":"object","properties":{"category":{"type":"string","description":"Category of the connection. The category of an existing connection cannot be updated.","enum":["database","basic","token","oauthV2"]}},"discriminator":{"propertyName":"category"}},"LogStatsResponse":{"type":"object","properties":{"warningCount":{"type":"integer","description":"Number of warnings","format":"int32"},"errorCount":{"type":"integer","description":"Number of errors","format":"int32"}},"description":"The log stats of the automation workflow"},"NewImapPublicationRequest":{"required":["fetchOption","filterType","imapAccount","imapPassword","imapPort","imapSecurity","imapServer","name","pollInterval","publisherName","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"imapServer":{"type":"string","description":"The mail exchange server domain name or IP address used for receiving email"},"imapPort":{"type":"integer","description":"The mail exchange TCP port used for receiving email","format":"int32","example":993},"imapAccount":{"type":"string","description":"The email account used for receiving email over IMAP. IMAP access must be enabled on this account. You cannot create multiple IMAP Publishers that reference the same address."},"imapPassword":{"type":"string","description":"The email account password used for receiving email over IMAP"},"imapSecurity":{"type":"string","description":"The encryption mechanism used for the IMAP connection","enum":["sslTls","startTls","none"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified IMAP server for email","format":"int32"},"fetchOption":{"type":"string","description":"Whether to fetch all unread messages from the inbox or only messages received after the previous fetch","enum":["newEmailsOnly","unreadEmails"]},"filterType":{"type":"string","description":"The filter, case-insensitive string match or regular expression, against the email subject line","enum":["simple","regex"]},"subjectFilter":{"type":"string","description":"Only fetch messages where the subject satisfies the filter. Wildcard characters are not supported. If the filter is left blank, then all unread/new messages will be fetched."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"NonWorkspaceItemResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the repository item"},"title":{"type":"string","description":"Title of the repository item"},"type":{"type":"string","description":"Type of repository item","enum":["workspace","customFormat","customTransformer","template"]},"buildNumber":{"type":"integer","description":"Build number of FME Form that this item was created or updated with.","format":"int64"},"category":{"type":"string","description":"Category the item is in"},"history":{"type":"string","description":"The history of the item"},"lastSaveDate":{"type":"string","description":"Last date the repository item was saved","format":"date-time"},"lastPublishDate":{"type":"string","description":"Last date the repository item was published","format":"date-time"},"lastSaveBuild":{"type":"string","description":"Last saved build of the item"},"legalTermsConditions":{"type":"string","description":"Legal Terms and Conditions for using the item"},"requirements":{"type":"string","description":"The requirements for this item"},"requirementsKeyword":{"type":"string","description":"The requirements keyword for this item"},"resources":{"type":"array","description":"Resources belonging to and used by the item","items":{"$ref":"#/components/schemas/Resource"}},"usage":{"type":"string","description":"The ways this item is used"},"username":{"type":"string","description":"The name of the user who added this item"},"fileSize":{"type":"integer","description":"Amount of storage, in bytes, occupied on the server by this item","format":"int64"},"favorite":{"type":"boolean","description":"Whether the item is a favorite"},"description":{"type":"string","description":"A human-readable description of the item"}}},"UpdateWebSocketPublicationRequest":{"required":["publisherName","streamID","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications. In this case, the requesting application is the Notification Service Publisher."}}}]},"NewRemoteEngineConnectionRequest":{"required":["name","password","url","username"],"type":"object","properties":{"type":{"type":"string","description":"Type of the Remote Engine connection.","enum":["standard","snowflake"]},"name":{"type":"string","description":"Name of the Remote Engine connection."},"url":{"type":"string","description":"URL of the Remote Engine."},"username":{"type":"string","description":"User to connect to Remote Engine."},"password":{"type":"string","description":"Password to connect to Remote Engine."},"queues":{"uniqueItems":true,"type":"array","description":"Queues to assign to the Remote Engine.","items":{"type":"string","description":"Queues to assign to the Remote Engine."}},"proxyConfiguration":{"$ref":"#/components/schemas/ProxyConfigRequest"},"numStandardEngines":{"type":"integer","description":"Number of Standard Engines.","format":"int32"},"numDynamicEngines":{"type":"integer","description":"Number of CPU-Usage Engines.","format":"int32"}},"discriminator":{"propertyName":"type"}},"SearchPropertiesResponse":{"type":"object","properties":{"useSimpleSearch":{"type":"boolean","description":"Specifies whether FME Flow should use a simplified query with no compound queries or wildcards when searching for users and groups"},"searchBases":{"uniqueItems":true,"type":"array","description":"Distinguished name of subtree used for searches","items":{"type":"string","description":"Distinguished name of subtree used for searches"}}},"description":"LDAP server search properties"},"UpdatePasswordExistingRemoteEngineConnectionRequest":{"required":["currentPassword","newPassword","url"],"type":"object","properties":{"type":{"type":"string","description":"Type of the Remote Engine connection.","enum":["standard","snowflake"]},"url":{"type":"string","description":"URL of the Remote Engine."},"currentPassword":{"type":"string","description":"Current password to connect to Remote Engine."},"newPassword":{"type":"string","description":"New password to update on Remote Engine."}},"discriminator":{"propertyName":"type"}},"NewJmsPublicationRequest":{"required":["connectionFactory","destinations","name","publisherName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."}}}]},"FtpSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32"},"username":{"type":"string","description":"The FTP user name for authentication"},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"transferType":{"type":"string","description":"The transfer method","enum":["auto","ascii","binary"]},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}},"NewScheduleRequest":{"required":["enabled","name","recurrence","repository","skipUntilJobComplete","workspace"],"type":"object","properties":{"name":{"type":"string","description":"Name of the schedule."},"enabled":{"type":"boolean","description":"Specifies whether the schedule is enabled or not."},"recurrence":{"type":"string","description":"Type of recurrence, either an interval or a CRON expression","enum":["cron","basic","interval","none"]},"cron":{"type":"string","description":"CRON expression (applies to 'cron' recurrence type)"},"begin":{"type":"string","description":"Date/time the schedule will begin","format":"date-time"},"end":{"type":"string","description":"Date/time the schedule will end and no longer run","format":"date-time"},"interval":{"type":"integer","description":"If `recurrence` is `interval`, the interval size, based on the specified `unit`","format":"int32"},"unit":{"type":"string","description":"If 'recurrence' is 'interval', the unit of interval","enum":["second","minute","hour","day","week","month","year"]},"description":{"type":"string","description":"Description of the schedule"},"skipUntilJobComplete":{"type":"boolean","description":"Option to prevent the schedule from triggering until the last triggered job is complete"},"repository":{"type":"string","description":"Repository containing the workspace to run"},"workspace":{"pattern":".*.(?i)fmw","type":"string","description":"The workspace to run"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"tags":{"type":"array","description":"Tags associated with the schedule","items":{"type":"string","description":"Tags associated with the schedule"}},"queue":{"type":"string","description":"The job routing queue"},"failureTopics":{"type":"array","description":"Topics to notify when the job fails","items":{"type":"string","description":"Topics to notify when the job fails"}},"successTopics":{"type":"array","description":"Topics to notify when the job succeeds","items":{"type":"string","description":"Topics to notify when the job succeeds"}},"maxJobRuntime":{"minimum":1,"type":"integer","description":"Time (in seconds) elapsed for a running job before it's cancelled. The minimum value is 1 second.","format":"int64"},"maxTimeInQueue":{"type":"integer","description":"Time to live in the job queue (in seconds)","format":"int64"},"logDebug":{"type":"boolean","description":"Whether the stream will run with debug logging or not"}}},"SystemEventsConfigurationResponse":{"type":"object","properties":{"sendEmail":{"type":"boolean","description":"Whether the configuration will send an email for each event"},"name":{"type":"string","description":"Name of the configuration"},"description":{"type":"string","description":"Description of the configuration"},"topic":{"type":"string","description":"Topic of the configuration"},"title":{"type":"string","description":"Title of the configuration"},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Parameters of the configuration"},"description":"Parameters of the configuration"},"enabled":{"type":"boolean","description":"Whether the configuration is enabled or not"}},"description":"Items in this results page"},"UpdatePasswordExpirationRequest":{"required":["daysUntilExpiration","enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether a password should expire after a specified number of days"},"daysUntilExpiration":{"maximum":365,"minimum":1,"type":"integer","description":"The number of days after which a password expires","format":"int64"}}},"OAuthV2ConnectionPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/OAuthV2ConnectionResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"ExportTaskResponse":{"type":"object","properties":{"jobID":{"type":"integer","description":"The ID of the export task.","format":"int64"}}},"TestDirWatchPublicationRequest":{"required":["directory","eventsToWatchFor","pollInterval","publisherName","watchFolder","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"directory":{"type":"string","description":"The directory to watch for activity"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"watchFolder":{"type":"boolean","description":"Whether to monitor activities on only files or both files and folders"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified Directory to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear.","format":"int32"}}}]},"PasswordChangeNeededRequest":{"required":["passwordChangeNeeded"],"type":"object","properties":{"passwordChangeNeeded":{"type":"boolean","description":"Whether the user account is required to change their password on the next login"}}},"SqsSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"queue":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to which you want to send messages"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"contentTemplate":{"type":"string","description":"The default message to send to the Amazon Web Services (AWS) SQS Queue. Can be up to 64 KB of text in any format."}}},"CleanupConfigurationRequest":{"required":["criticalMinimumDiskPercent","criticalMinimumDiskSpace","criticalOperation","taskInterval","warningMinimumDiskPercent","warningMinimumDiskSpace","warningOperation","watchInterval"],"type":"object","properties":{"criticalMinimumDiskPercent":{"maximum":100,"minimum":0,"type":"integer","description":"The minimum free disk space size, in percentage, for a critical level cleanup event","format":"int32"},"criticalMinimumDiskSpace":{"minimum":0,"type":"integer","description":"The minimum free disk space size, in gigabytes, for a critical level cleanup event","format":"int32"},"criticalNotificationTopic":{"type":"string","description":"The Notification Service topic to notify when critical level minimum free disk space criteria are met"},"criticalOperation":{"type":"string","description":"For a critical level cleanup event to be triggered, the free disk space percentage and/or the free disk space size in gigabytes must be below their respective critical thresholds. This value determines if both the disk space percentage and disk space size must be met (`and`), or if meeting either criterion is sufficient (`or`).","enum":["and","or"]},"taskInterval":{"minimum":1,"type":"integer","description":"The frequency, in seconds, in which cleanup tasks are executed","format":"int64"},"warningMinimumDiskPercent":{"maximum":100,"minimum":0,"type":"integer","description":"The minimum free disk space size, in percentage, for a warning level cleanup event","format":"int32"},"warningMinimumDiskSpace":{"minimum":0,"type":"integer","description":"The minimum free disk space size, in gigabytes, for a warning level cleanup event","format":"int32"},"warningNotificationTopic":{"type":"string","description":"The Notification Service topic to notify when warning level minimum free disk space criteria are met"},"warningOperation":{"type":"string","description":"For a warning level cleanup event to be triggered, the free disk space percentage and/or the free disk space size in gigabytes must be below their respective warning thresholds. This value determines if both the disk space percentage and disk space size must be met (`and`), or if meeting either criterion is sufficient (`or`).","enum":["and","or"]},"watchInterval":{"minimum":1,"type":"integer","description":"The frequency, in seconds, in which system source paths are checked to ensure minimum free disk space criteria are met","format":"int64"}}},"ImportFromResourceRequest":{"required":["resourceName","resourcePath"],"type":"object","properties":{"resourceName":{"type":"string","description":"Resource containing the import package."},"resourcePath":{"type":"string","description":"Path and name of the import package."},"skipPreview":{"type":"boolean","description":"If true, perform a quick import by not generating the preview.","default":false}}},"NewSqsSubscriptionRequest":{"required":["accessKeyID","name","queue","secretAccessKey","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"queue":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to which you want to send messages"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"contentTemplate":{"type":"string","description":"The default message to send to the Amazon Web Services (AWS) SQS Queue. Can be up to 64 KB of text in any format."}}}]},"UpdateOAuthV2ConnectionRequest":{"required":["category"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateConnectionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token value"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format (e.g., 2025-01-01T12:00-08:00).","format":"date-time"},"refreshToken":{"type":"string","description":"The refresh token"},"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters for the connection"},"description":"The parameters for the connection"}}}]},"JmsSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."},"deliveryMode":{"type":"string","description":"Whether messages are stored by the JMS broker until the message is delivered to a destination, and can be recovered in the event of a broker restart","enum":["persistent","nonPersistent"]},"contentTemplate":{"type":"string","description":"The message body"}}},"TestJmsSubscriptionRequest":{"required":["connectionFactory","deliveryMode","destinations","subscriberName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."},"deliveryMode":{"type":"string","description":"Whether messages are stored by the JMS broker until the message is delivered to a destination, and can be recovered in the event of a broker restart","enum":["persistent","nonPersistent"]},"contentTemplate":{"type":"string","description":"The message body"}}}]},"SmtpPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"emailUserName":{"type":"string","description":"The username of the email address on the FME Flow host system that receives the notification email. For example, if the FME Flow host name is services.internal, and the email address is user@services.internal, enter user."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."}}},"LDAPAccountInfoResponse":{"type":"object","properties":{"authenticationID":{"type":"string","description":"Authentication ID of the LDAP user"},"distinguishedName":{"type":"string","description":"Distinguished name of the LDAP user"},"email":{"type":"string","description":"Email address of the LDAP user"},"fullName":{"type":"string","description":"Full name of the LDAP user"},"linkedAccountName":{"type":"string","description":"Linked account name"},"name":{"type":"string","description":"Name of the LDAP user"},"serverName":{"type":"string","description":"Name of the LDAP server"}},"description":"Linked LDAP account information"},"NewSharedResourceRequest":{"required":["displayName","name","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of the resource connection"},"displayName":{"type":"string","description":"Display name of the resource connection"},"description":{"type":"string","description":"Description of the resource connection"},"type":{"type":"string","description":"Type of the resource connection","enum":["file","awsS3","network"]},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Resource type-specific properties"},"description":"Resource type-specific properties"}}},"EntraIDPrimaryTenantPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/EntraIDPrimaryTenantResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"EntraIDRoleResponse":{"type":"object","properties":{"azureGroupID":{"type":"string","description":"The unique ID of the Azure security group","format":"uuid"},"tenantID":{"type":"string","description":"Name of the Azure AD tenant the group belongs to","format":"uuid"},"linkedRoleID":{"type":"string","description":"UUID of the linked role","format":"uuid"},"linkedRoleName":{"type":"string","description":"Name of the linked role"},"groupName":{"type":"string","description":"Name of the Azure AD security group"}},"description":"Items in this results page"},"MigrationTasksPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/MigrationTaskResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"JobCountInterval":{"type":"object","properties":{"interval":{"type":"string","description":"Interval date","format":"date-time"},"jobCount":{"type":"integer","description":"Number of jobs in the interval date","format":"int64"}},"description":"Items in this results page"},"ImportItemResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier. Format varies by item type."},"jobID":{"type":"integer","description":"The associated import job","format":"int64"},"name":{"type":"string","description":"Display name"},"type":{"$ref":"#/components/schemas/ImportItemType"},"ownerID":{"type":"string","description":"Owner. If null, the fallback owner will be used when importing","format":"uuid"},"ownerName":{"type":"string","description":"Owner name"},"ownerStatus":{"type":"string","description":"Owner status","enum":["noMatch","inProject","nameMatch","idMatch","none"]},"originalOwner":{"type":"string","description":"Original owner name in project"},"selected":{"type":"boolean","description":"If the item is selectable, whether it has been selected for import"},"existing":{"type":"boolean","description":"Whether the item already exists on the target server"},"previewAction":{"type":"string","description":"What action is predicted to happen during import","enum":["unknown","created","overwritten","skipped","failed"]},"action":{"type":"string","description":"What action actually happened during import","enum":["unknown","created","overwritten","skipped","failed"]},"source":{"type":"string","description":"The origin of the item. Either a root project item or a dependency","enum":["project","dependency"]}}},"StreamResponse":{"required":["repository","workspace"],"type":"object","properties":{"id":{"type":"string","description":"UUID of the stream","format":"uuid"},"queueName":{"type":"string","description":"Internal queue identifier for Kubernetes deployments"},"ownerID":{"type":"string","description":"UUID of the user that owns the stream","format":"uuid"},"owner":{"type":"string","description":"Owner of the stream"},"name":{"type":"string","description":"Display name of the stream"},"state":{"type":"string","description":"State of the stream","enum":["stale","inSync","deleting"]},"description":{"type":"string","description":"Description of the stream"},"lastUpdatedUserID":{"type":"string","description":"User who last updated, enabled, or disabled the stream","format":"uuid"},"enabled":{"type":"boolean","description":"Whether the stream is enabled or not"},"created":{"type":"string","description":"When the stream was created","format":"date-time"},"lastUpdated":{"type":"string","description":"When the stream was last modified","format":"date-time"},"engines":{"$ref":"#/components/schemas/StreamEngineInfo"},"repository":{"type":"string","description":"The repository of the job to run"},"workspace":{"pattern":".*.(?i)fmw","type":"string","description":"The workspace of the job to run","example":"string"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"logDebug":{"type":"boolean","description":"Whether the stream will run with debug logging or not"},"engineRuleExists":{"type":"boolean","description":"Whether the stream already has engine rule or not"},"type":{"type":"string","description":"Type of stream","enum":["standard","remote"]},"remoteConfiguration":{"$ref":"#/components/schemas/StreamRemoteConfig"}}},"EngineRuleResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the engine assignment rule","format":"uuid"},"type":{"type":"string","description":"Type of engine assignment rule","enum":["name","property"]},"name":{"type":"string","description":"Name of engine assignment rule"},"rule":{"type":"string","description":"Engine assignment rule"},"queues":{"type":"array","description":"Queues to assign engines to","items":{"type":"string","description":"Queues to assign engines to"}},"activePeriods":{"type":"array","description":"Engine rules assigned to the active period","items":{"$ref":"#/components/schemas/EngineRuleActivePeriodAssignmentResponse"}},"enabled":{"type":"boolean","description":"Indicates if engine assignment rule is enabled"}},"description":"Items in this results page"},"TestDropboxWatchPublicationRequest":{"required":["accessToken","eventsToWatchFor","path","publisherName","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"path":{"type":"string","description":"The location on your Dropbox account to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"NewSftpSubscriptionRequest":{"required":["host","name","port","remoteUploadDirectory","subscriberName","username","verifyHostKey"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The SFTP host name"},"port":{"type":"integer","description":"The SFTP port number","format":"int32","example":22},"username":{"type":"string","description":"The SFTP username for authentication"},"password":{"type":"string","description":"The SFTP user password for authentication"},"verifyHostKey":{"type":"boolean","description":"Whether to verify the host key for the server being connected to"},"knownHostsFile":{"type":"string","description":"The path to the known_hosts file that contains the public keys for any servers you wish to connect to, if verifying host key. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"localSourcePath":{"type":"string","description":"The source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file"}}}]},"SharedResourcePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/SharedResourceResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"ScheduleSummaryResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the schedule","format":"uuid"},"name":{"type":"string","description":"Name of the schedule."},"enabled":{"type":"boolean","description":"Specifies whether the schedule is enabled or not."},"owner":{"type":"string","description":"Username of the owner of the schedule"},"ownerID":{"type":"string","description":"UUID of the owner of the schedule","format":"uuid"},"recurrence":{"type":"string","description":"Type of recurrence, either an interval or a CRON expression","enum":["cron","basic","interval","none"]},"cron":{"type":"string","description":"CRON expression (applies to 'cron' recurrence type)"},"begin":{"type":"string","description":"Date/time the schedule will begin"},"end":{"type":"string","description":"Date/time the schedule will end and no longer run"},"interval":{"type":"integer","description":"If `recurrence` is `interval`, the interval size, based on the specified `unit`","format":"int32"},"unit":{"type":"string","description":"If 'recurrence' is 'interval', the unit of interval","enum":["second","minute","hour","day","week","month","year"]},"tags":{"type":"array","description":"Tags associated with the schedule","items":{"type":"string","description":"Tags associated with the schedule"}},"shareable":{"type":"boolean","description":"Whether the schedule is shareable or not"},"repository":{"type":"string","description":"Repository containing the workspace to run"},"workspace":{"type":"string","description":"The workspace to run"},"totalRuns":{"type":"integer","description":"Total number of job runs","format":"int64"},"averageCpuTime":{"type":"integer","description":"Average CPU time","format":"int64"},"averageCpuPercent":{"type":"number","description":"Average CPU percentage","format":"double"},"averageElapsedTime":{"type":"integer","description":"Average elapsed time","format":"int64"},"averagePeakMemoryUsage":{"type":"integer","description":"Average peak memory usage","format":"int64"}},"description":"Items in this results page"},"LdapServerConnectionOptionsResponse":{"type":"object","properties":{"searchUser":{"type":"string","description":"Distinguished name of service account used for searches"},"searchUserPassword":{"type":"string","description":"Password for the service account used for searches"},"redundantServers":{"type":"array","description":"Additional LDAP servers used for maintaining high availability.","items":{"$ref":"#/components/schemas/RedundantServerResponse"}}},"description":"LDAP server connection options"},"EnableJobRuleRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates if job routing rule is enabled"}}},"UpdateAccountRequest":{"required":["enabled","fullName","passwordChangeNeeded","sharingEnabled"],"type":"object","properties":{"fullName":{"type":"string","description":"Full name of the account user."},"email":{"type":"string","description":"Email of the account user."},"password":{"type":"string","description":"Password for the account."},"roles":{"uniqueItems":true,"type":"array","description":"Roles to assign to the account.","items":{"type":"string","description":"Roles to assign to the account.","format":"uuid"}},"enabled":{"type":"boolean","description":"Specifies whether the account is enabled or not"},"sharingEnabled":{"type":"boolean","description":"Specifies whether the account is allowed to share items with other users and roles."},"passwordChangeNeeded":{"type":"boolean","description":"Specifies whether a password is required to be changed on the next login."}}},"NewLoggerSubscriptionRequest":{"required":["logLevel","name","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"logLevel":{"type":"string","description":"The level of detail of the notification message in the log file","enum":["low","normal","high"]}}}]},"NewEntraIDTenantRequest":{"required":["name","tenantID","tenantType"],"type":"object","properties":{"tenantType":{"type":"string","description":"Type of the tenant","enum":["primary","secondary"]},"tenantID":{"type":"string","description":"Directory (tenant) ID","format":"uuid"},"name":{"type":"string","description":"Name of the Azure AD tenant"},"syncEnabled":{"type":"boolean","description":"Specifies whether synchronizing users and groups for the Azure AD tenant is enabled or not."},"syncIntervalSeconds":{"type":"integer","description":"If syncEnabled is true, this interval specifies how often to synchronize Azure AD tenant users and groups, in seconds.","format":"int32"}},"discriminator":{"propertyName":"tenantType"}},"ActivePeriodPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ActivePeriodResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"Attribute":{"type":"object","properties":{"decimals":{"type":"integer","description":"The decimals for the attribute","format":"int64"},"name":{"type":"string","description":"Unique name of the attribute"},"type":{"type":"string","description":"The type of the attribute"},"width":{"type":"integer","description":"The width of the attribute","format":"int64"}},"description":"Attributes defined for the feature type"},"IdentityProviderDetails":{"type":"object","properties":{"ssoURL":{"type":"string","description":"Identity Provider SSO URL"},"entityID":{"type":"string","description":"Identity Provider Issuer"},"idpCertificateInstalled":{"type":"boolean","description":"Whether the IDP certificate file has been installed"}},"description":"The identity provider details"},"RemoteEngineConnectionResponseSnowflake":{"type":"object","allOf":[{"$ref":"#/components/schemas/RemoteEngineConnectionResponse"},{"type":"object","properties":{"snowflakeAuthentication":{"$ref":"#/components/schemas/SnowflakeAuthResponse"}}}]},"EncryptionConfigResponse":{"type":"object","properties":{"keys":{"type":"array","description":"The list of encryption keys","items":{"$ref":"#/components/schemas/EncryptionKeyResponse"}},"mode":{"type":"string","description":"The encryption mode","enum":["weak","standard"]}}},"ProjectPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ProjectResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"SaslAuthenticationPropertiesResponse":{"type":"object","properties":{"saslMechanism":{"type":"string","description":"SASL authentication mechanism.","enum":["gssapi","external"]},"kdcAddress":{"type":"string","description":"Host address of the Key Distribution Center (KDC)."},"realm":{"type":"string","description":"Authentication realm name."},"channelBinding":{"type":"boolean","description":"Channel binding enabled"}},"description":"Properties used for SASL authentication"},"DataVirtualizationSchemaSummaryResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the schema","format":"uuid"},"name":{"type":"string","description":"Name of the schema"},"description":{"type":"string","description":"Description of the schema"}},"description":"Items in this results page"},"DetailedAccountResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the account","format":"uuid"},"name":{"type":"string","description":"Unique name of the account"},"fullName":{"type":"string","description":"Full name of the account user"},"email":{"type":"string","description":"Email of the account user"},"roles":{"type":"array","description":"Roles assigned to the account","items":{"$ref":"#/components/schemas/AccountRoleAssignmentResponse"}},"isSuperUser":{"type":"boolean","description":"Whether the account has elevated permissions allowed to perform any operation of FME Flow"},"enabled":{"type":"boolean","description":"Whether the account is enabled or not"},"sharingEnabled":{"type":"boolean","description":"Whether the account is allowed to share items with other users and roles"},"type":{"type":"string","description":"Type of the account","enum":["system","ldap","azure","saml"]},"password":{"type":"string","description":"Password of the account user (this is a sensitive field and will always return `null`)"},"passwordChangeNeeded":{"type":"boolean","description":"Whether to require changing of password on next login"},"passwordExpired":{"type":"boolean","description":"Whether the account password is expired"},"ldapInfo":{"$ref":"#/components/schemas/LDAPAccountInfoResponse"}}},"JobPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/JobSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewProjectItemRequest":{"required":["id","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/ProjectItemType"},"id":{"type":"string","description":"A unique identifier for the item. May be the item's UUID, name, or a combination of the file path and name."}}},"GenericLookupAttributesRequest":{"required":["group","username"],"type":"object","properties":{"fullName":{"type":"string","description":"Attribute containing the full name of the LDAP user. When omitted, 'displayName' is used"},"email":{"type":"string","description":"Attribute containing the email address of the LDAP user"},"group":{"type":"string","description":"Attribute containing the name of the LDAP group."},"username":{"type":"string","description":"Attribute containing the name of the LDAP user."},"memberOf":{"type":"string","description":"Attribute containing the group membership of a user or group. When omitted, group membership lookups are not used"}},"description":"Attributes used to fetch user and group details"},"TestHttpSubscriptionRequest":{"required":["acceptHeader","contentType","requestType","subscriberName","url","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"requestType":{"type":"string","description":"The type of HTTP request","enum":["get","post","put","delete"]},"url":{"type":"string","description":"The URL to which notifications on the associated topics are delivered via HTTP POST"},"httpUsername":{"type":"string","description":"The username when the target URL requires HTTP authentication"},"httpPassword":{"type":"string","description":"The user password when the target URL requires HTTP authentication"},"acceptHeader":{"type":"string","description":"Format of the Accept request HTTP header: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"contentType":{"type":"string","description":"The format in which to deliver content: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"contentTemplate":{"type":"string","description":"The message body content. If specified, this message replaces the incoming message body."}}}]},"NewRepositoryRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the repository."},"description":{"type":"string","description":"Description of the repository."}}},"UpdateGenericLdapServerRequest":{"required":["authentication","connectionOptions","encryption","host","lookupAttributes","port","searchObjectClasses"],"type":"object","properties":{"host":{"type":"string","description":"LDAP server host"},"port":{"type":"integer","description":"LDAP server port","format":"int32"},"encryption":{"type":"string","description":"Encryption mode","enum":["none","ssl","startTls"]},"connectionOptions":{"$ref":"#/components/schemas/LdapServerConnectionOptionsUpdateRequest"},"authentication":{"type":"string","description":"Authentication mechanism","enum":["basic","sasl","sso"]},"saslAuthenticationProperties":{"$ref":"#/components/schemas/SaslAuthenticationPropertiesRequest"},"searchProperties":{"$ref":"#/components/schemas/SearchPropertiesRequest"},"syncOptions":{"$ref":"#/components/schemas/SyncOptionsRequest"},"lookupAttributes":{"$ref":"#/components/schemas/GenericLookupAttributesRequest"},"searchObjectClasses":{"$ref":"#/components/schemas/LdapServerObjectClassesRequest"}}},"UpdateJmsSubscriptionRequest":{"required":["connectionFactory","deliveryMode","destinations","subscriberName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."},"deliveryMode":{"type":"string","description":"Whether messages are stored by the JMS broker until the message is delivered to a destination, and can be recovered in the event of a broker restart","enum":["persistent","nonPersistent"]},"contentTemplate":{"type":"string","description":"The message body"}}}]},"SAMLConfigurationEnableRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates if SAML configuration is enabled"}}},"NewRemoteEngineConnectionRequestSnowflake":{"required":["name","password","snowflakeAuthentication","url","username"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewRemoteEngineConnectionRequest"},{"type":"object","properties":{"snowflakeAuthentication":{"$ref":"#/components/schemas/NewSnowflakeAuthRequest"}}}]},"TestExistingSnsPublicationRequest":{"required":["publisherName","subscriptionArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"subscriptionArn":{"type":"string","description":"The Amazon Web Services (AWS) SNS Subscription ID"}}}]},"UpdateSnowflakeAuthRequest":{"required":["account","endpoint","role","user"],"type":"object","properties":{"account":{"type":"string","description":"Account to connect to Remote Engine."},"user":{"type":"string","description":"User to connect to Remote Engine."},"role":{"type":"string","description":"Role to connect to Remote Engine."},"endpoint":{"type":"string","description":"Endpoint of the Remote Engine."},"privateKey":{"type":"string","description":"Private key to connect to Remote Engine."},"publicKey":{"type":"string","description":"Public key to connect to Remote Engine."}},"description":"Snowflake configuration for the Remote Engine."},"RoleWithLdapInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the role","format":"uuid"},"name":{"type":"string","description":"Name of the role"},"accounts":{"type":"array","description":"Roles assigned to the account","items":{"$ref":"#/components/schemas/RoleAccountAssignmentResponse"}},"type":{"type":"string","description":"Type of the role","enum":["system","ldap","azure"]},"ldapInfo":{"$ref":"#/components/schemas/LDAPRoleInfoResponse"}}},"DropboxSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"}}},"TestExistingWebSocketSubscriptionRequest":{"required":["streamID","subscriberName","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications."},"template":{"type":"string","description":"The message sent in the stream"}}}]},"SubscriptionPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/SubscriptionSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"ProjectTaskResponse":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the project task.","format":"int64"},"type":{"type":"string","description":"Type of project task.","enum":["projectImport","projectExport"]},"username":{"type":"string","description":"Username of user who triggered task."},"startDate":{"type":"string","description":"Start date of task.","format":"date-time"},"finishedDate":{"type":"string","description":"Finish date of task.","format":"date-time"},"status":{"type":"string","description":"Status of task.","enum":["submitted","running","success","failure"]},"projectName":{"type":"string","description":"Name of project included in the export package."},"successTopic":{"type":"string","description":"Topic to notify on success."},"failureTopic":{"type":"string","description":"Topic to notify on failure."},"resourceName":{"type":"string","description":"Resource containing the package."},"packagePath":{"type":"string","description":"Path of the package."},"packageName":{"type":"string","description":"Name of the package."},"importMode":{"type":"string","description":"The import mode for the files in the project.","enum":["overwrite","insert"]},"projectsImportMode":{"type":"string","description":"The import mode for the project.","enum":["overwrite","insert"]},"pauseNotifications":{"type":"boolean","description":"Disable notifications for the duration of the project import."},"result":{"type":"string","description":"Result of the project task."},"excludeSensitiveInfo":{"type":"boolean","description":"Exclude sensitive information from the exported project."},"disableProjectItems":{"type":"boolean","description":"Disable project items after import"}},"description":"Items in this results page"},"DetailedEngineResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the engine"},"hostname":{"type":"string","description":"The hostname of the node the engine is running on"},"engineManagerHostname":{"type":"string","description":"The hostname of the FME Flow core node the engine is registered to"},"platform":{"type":"string","description":"The OS and platform"},"currentJobID":{"type":"integer","description":"The ID of the job the engine is currently running (null if none)","format":"int64"},"buildNumber":{"type":"integer","description":"The FME build number","format":"int32"},"type":{"type":"string","description":"The engine type (Dynamic, Standard)","enum":["standard","dynamic"]},"state":{"type":"string","description":"The engine state (Idle, Running Job, Disconnected)","enum":["idle","runningJob","disconnected"]},"assignedQueues":{"type":"array","description":"The queues assigned to the engine","items":{"type":"string","description":"The queues assigned to the engine"}},"registrationProperties":{"type":"array","description":"Registration properties for the engine","items":{"type":"string","description":"Registration properties for the engine"}},"hostProperties":{"$ref":"#/components/schemas/HostProperties"}},"description":"Items in this results page"},"Services":{"type":"object","properties":{"fmedatadownload":{"$ref":"#/components/schemas/DataDownload"},"fmedatastreaming":{"$ref":"#/components/schemas/DataStreaming"},"fmejobsubmitter":{"$ref":"#/components/schemas/JobSubmitter"},"fmekmllink":{"$ref":"#/components/schemas/KMLNetworkLink"},"fmenotification":{"$ref":"#/components/schemas/Notification"}},"description":"Services the item is registered with"},"CreateDataVirtualizationApiRequest":{"required":["asyncProcessing","caching","namespace","security","title","version"],"type":"object","properties":{"title":{"type":"string","description":"Title of the API"},"namespace":{"type":"string","description":"Namespace of the API"},"version":{"type":"string","description":"Version of the API","example":"1.0.0"},"summary":{"type":"string","description":"Short summary of the API"},"description":{"type":"string","description":"Description of the API"},"queue":{"type":"string","description":"Assigned queue for all jobs run by the API"},"jobExpiryInSeconds":{"minimum":1,"type":"integer","description":"Maximum run time for a job, including its time in a queue, in seconds. The job will be cancelled if it exceeds this duration. Default is 2 minutes.","format":"int64"},"contactName":{"type":"string","description":"Contact person or organization"},"contactURL":{"type":"string","description":"Address pointing to the contact information"},"contactEmail":{"type":"string","description":"Email address of the contact person or organization"},"security":{"$ref":"#/components/schemas/DataVirtualizationApiSecurityRequest"},"caching":{"$ref":"#/components/schemas/DataVirtualizationApiCachingRequest"},"asyncProcessing":{"$ref":"#/components/schemas/DataVirtualizationApiAsyncRequest"}}},"DataVirtualizationWorkspaceListResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the workspace"},"isUsed":{"type":"boolean","description":"True if the workspace is associated with endpoints"}},"description":"Items in this results page"},"TestExistingDirWatchPublicationRequest":{"required":["directory","eventsToWatchFor","pollInterval","publisherName","watchFolder","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"directory":{"type":"string","description":"The directory to watch for activity"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"watchFolder":{"type":"boolean","description":"Whether to monitor activities on only files or both files and folders"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified Directory to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear.","format":"int32"}}}]},"NewWebSocketPublicationRequest":{"required":["name","publisherName","streamID","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications. In this case, the requesting application is the Notification Service Publisher."}}}]},"UpdateRemoteEngineConnectionRequestSnowflake":{"required":["name","snowflakeAuthentication","url","username"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateRemoteEngineConnectionRequest"},{"type":"object","properties":{"snowflakeAuthentication":{"$ref":"#/components/schemas/UpdateSnowflakeAuthRequest"}}}]},"ImportItemsPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ImportItemResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TestExistingWebSocketPublicationRequest":{"required":["publisherName","streamID","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications. In this case, the requesting application is the Notification Service Publisher."}}}]},"JmsPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."}}},"TestStatus":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the test succeeded or not"},"message":{"type":"string","description":"Message describing the status of the test operation"}}},"NewHttpSubscriptionRequest":{"required":["acceptHeader","contentType","name","requestType","subscriberName","url","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"requestType":{"type":"string","description":"The type of HTTP request","enum":["get","post","put","delete"]},"url":{"type":"string","description":"The URL to which notifications on the associated topics are delivered via HTTP POST"},"httpUsername":{"type":"string","description":"The username when the target URL requires HTTP authentication"},"httpPassword":{"type":"string","description":"The user password when the target URL requires HTTP authentication"},"acceptHeader":{"type":"string","description":"Format of the Accept request HTTP header: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"contentType":{"type":"string","description":"The format in which to deliver content: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"contentTemplate":{"type":"string","description":"The message body content. If specified, this message replaces the incoming message body."}}}]},"SearchPropertiesRequest":{"type":"object","properties":{"useSimpleSearch":{"type":"boolean","description":"Specifies whether FME Flow should use a simplified query with no compound queries or wildcards when searching for users and groups. This is false by default."},"searchBases":{"uniqueItems":true,"type":"array","description":"Distinguished name of subtree used for searches","items":{"type":"string","description":"Distinguished name of subtree used for searches"}}},"description":"LDAP server search properties"},"PublicationPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/PublicationSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdateSqsPublicationRequest":{"required":["accessKeyID","deleteMessageAfterReceived","publisherName","queueUrl","visibilityTimeout"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"queueUrl":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to pull messages from"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"deleteMessageAfterReceived":{"type":"boolean","description":"Whether to automatically delete the message after it has been received"},"visibilityTimeout":{"maximum":43200,"minimum":0,"type":"integer","description":"The visibility timeout (in seconds) for the Amazon Web Services (AWS) SQS Queue","format":"int32"}}}]},"NewTopicRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the topic"},"description":{"type":"string","description":"Description of the topic"}}},"SourceType":{"type":"string","enum":["automations","workspaceSubscriptions","schedules","workspaceApps","automationApps","streams","fmeflow","dataVirtualization"]},"ImportPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ImportResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"DataStreaming":{"type":"object","properties":{"registered":{"type":"boolean","description":"Whether the service is registered or not"},"reader":{"type":"string","description":"Reader to replace with HTTP body or internet download"},"writers":{"type":"array","description":"Writers to include in Data Streaming","items":{"type":"string","description":"Writers to include in Data Streaming"}},"successTopics":{"type":"array","description":"Topics to notify on success","items":{"type":"string","description":"Topics to notify on success"}},"failureTopics":{"type":"array","description":"Topics to notify on failure","items":{"type":"string","description":"Topics to notify on failure"}},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Properties for the service"},"description":"Properties for the service"}},"description":"Data Streaming service properties"},"TestExistingEventGridPublicationRequest":{"required":["publisherName","webhookEndpoint"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"webhookEndpoint":{"type":"string","description":"The WebHook endpoint from which to receive events. The ID parameter acts as an access token to verify that the event is coming from Azure Event Grid and should be kept private. Azure Event Grid only supports publicly accessible HTTPS webhook endpoints using a valid certificate."}}}]},"JobResultResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this job","format":"int64"},"featureOutputCount":{"type":"integer","description":"Number of features output by this job","format":"int64"},"requesterHost":{"type":"string","description":"The host of the requester of this job"},"requesterResultPort":{"type":"integer","description":"The result port of the requester of this job","format":"int32"},"status":{"type":"string","description":"The current status of this job","enum":["queued","running","success","failure","cancelled"]},"statusMessage":{"type":"string","description":"The status message of this job"},"timeFinished":{"type":"string","description":"The date this job was completed","format":"date-time"},"timeQueued":{"type":"string","description":"The date this job was queued","format":"date-time"},"timeStarted":{"type":"string","description":"The date this job was started","format":"date-time"}}},"DataVirtualizationApiResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the API","format":"uuid"},"title":{"type":"string","description":"Title of the API"},"namespace":{"type":"string","description":"Namespace of the API"},"version":{"type":"string","description":"Version of the API"},"summary":{"type":"string","description":"Short summary of the API"},"description":{"type":"string","description":"Description of the API"},"owner":{"type":"string","description":"Name of the user that owns the Data Virtualization API"},"ownerID":{"type":"string","description":"ID of the user that owns the Data Virtualization API","format":"uuid"},"lastUpdated":{"type":"string","description":"When the Data Virtualization API was last modified","format":"date-time"},"queue":{"type":"string","description":"Assigned queue for all jobs run by the API"},"jobExpiryInSeconds":{"type":"integer","description":"Maximum run time for a job, including its time in a queue, in seconds.The job will be cancelled if it exceeds this duration. Default is 2 minutes.","format":"int64"},"contactName":{"type":"string","description":"Contact person or organization"},"contactURL":{"type":"string","description":"Address pointing to the contact information"},"contactEmail":{"type":"string","description":"Email address of the contact person or organization"},"security":{"$ref":"#/components/schemas/DataVirtualizationApiSecurityResponse"},"caching":{"$ref":"#/components/schemas/DataVirtualizationApiCachingResponse"},"asyncProcessing":{"$ref":"#/components/schemas/DataVirtualizationApiAsyncResponse"}},"description":"Items in this results page"},"DownloadWorkspacesRequest":{"required":["workspaces","zipFileName"],"type":"object","properties":{"workspaces":{"type":"array","description":"List of up to 500 workspaces to be downloaded.","items":{"pattern":".*.(?i)fmw","type":"string","description":"List of up to 500 workspaces to be downloaded."}},"zipFileName":{"type":"string","description":"Name of the downloaded zipped file."}}},"ItemSummaryPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ItemSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewSnsPublicationRequest":{"required":["name","publisherName","subscriptionArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"subscriptionArn":{"type":"string","description":"The Amazon Web Services (AWS) SNS Subscription ID"}}}]},"AppParameter":{"required":["name","showInApp","useDefaultValue"],"type":"object","properties":{"name":{"type":"string","description":"The name of the published parameter"},"useDefaultValue":{"type":"boolean","description":"Whether the default value should be used"},"showInApp":{"type":"boolean","description":"Whether the parameter should be shown in the app"},"value":{"type":"object","description":"The value of the published parameter"}},"description":"Parameter for an app"},"NewPublicationRequest":{"required":["name","publisherName"],"type":"object","properties":{"name":{"type":"string","description":"Unique name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication","enum":["sqs","dropboxwatch","dirwatch","eventgrid","sns","s3watch","ftpwatch","jms","smtp","websocket","udp","imap"]},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}}},"discriminator":{"propertyName":"publisherName"}},"DeploymentParameterPasswordResponse":{"type":"object","allOf":[{"$ref":"#/components/schemas/DeploymentParameterResponse"}]},"NewS3SubscriptionRequest":{"required":["accessKeyID","bucket","encryption","name","permission","secretAccessKey","subscriberName","version"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The name of the Amazon Web Services (AWS) S3 Bucket to which you want to upload"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"encryption":{"type":"string","description":"Whether to enable Amazon Web Services (AWS) S3 Server-Side Encryption. When enabled, S3 encrypts your data using AES-256 encryption mode.","enum":["none","sse"]},"permission":{"type":"string","description":"The predefined set of grantees and permissions to store with each uploaded object","enum":["privatePermission","publicRead","publicWrite","authRead","bucketRead","bucketFull"]},"version":{"type":"string","description":"Whether to enable versioning for the specified Amazon Web Services (AWS) S3 Bucket. To maintain the current behavior, or if you do not have permission to set S3 Bucket versioning, leave as \"Default\".","enum":["yes","no","defaultVersioning"]},"localSourcePath":{"type":"string","description":"The path to the file/folder to be uploaded. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The location in the specified Amazon Web Services (AWS) S3 Bucket to upload objects to, using forward slashes (/). If left blank, objects are uploaded to the S3 Bucket’s root."}}}]},"UpdateCategoryPermissionRequest":{"required":["name","permissions"],"type":"object","properties":{"name":{"type":"string","description":"Name of the security category"},"permissions":{"type":"array","description":"Permissions granted for this category","items":{"type":"string","description":"Permissions granted for this category"}}}},"CopyRequest":{"required":["destinationPath","items","path"],"type":"object","properties":{"path":{"type":"string","description":"Source directory relative to the resource connection from which to recursively copy."},"items":{"type":"array","description":"List of up to 500 file or folder names to be copied.","items":{"type":"string","description":"List of up to 500 file or folder names to be copied."}},"destinationPath":{"type":"string","description":"Destination directory, relative to the same resource connection or another one specified, to copy the items to."},"destinationResource":{"type":"string","description":"Name of the resource connection to receive the items. If not supplied, then the items are copied to the same resource connection."}}},"ImportEntraIDUserRequest":{"required":["userID"],"type":"object","properties":{"userID":{"type":"string","description":"The object id of the Microsoft Entra (Azure AD) user.","format":"uuid"},"username":{"type":"string","description":"Name of the FME Flow account. If not supplied, will be automatically generated from the imported user."}}},"TestExistingPublicationRequest":{"required":["publisherName"],"type":"object","properties":{"publisherName":{"type":"string","description":"The communication protocol used for the publication","enum":["sqs","dropboxwatch","dirwatch","eventgrid","sns","s3watch","ftpwatch","jms","smtp","websocket","udp","imap"]}},"discriminator":{"propertyName":"publisherName"}},"TopicPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/TopicResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TopicMonitoringPortRequest":{"type":"object","properties":{"port":{"type":"integer","description":"The external websocket port to set.","format":"int32"}}},"GenericLdapServerPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/GenericLdapServerResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"DetailedEnginePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DetailedEngineResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"SyncOptionsRequest":{"type":"object","properties":{"enableSync":{"type":"boolean","description":"Specifies whether synchronizing LDAP users and groups is enabled or not. This is false by default."},"syncInterval":{"minimum":60,"type":"integer","description":"If enableSync is true, this interval specifies how often to synchronize LDAP users and groups, in seconds","format":"int32"}},"description":"LDAP server synchronization options"},"TestSqsSubscriptionRequest":{"required":["accessKeyID","queue","secretAccessKey","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"queue":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to which you want to send messages"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS queue"},"contentTemplate":{"type":"string","description":"The default message to send to the Amazon Web Services (AWS) SQS Queue. Can be up to 64 KB of text in any format."}}}]},"TestExistingRemoteEngineConnectionRequestSnowflake":{"required":["snowflakeAuthentication"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingRemoteEngineConnectionRequest"},{"type":"object","properties":{"snowflakeAuthentication":{"$ref":"#/components/schemas/UpdateSnowflakeAuthRequest"}}}]},"ProjectResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the project.","format":"uuid"},"name":{"type":"string","description":"Name of the project."},"hubUID":{"type":"string","description":"The project UID used for publishing to FME Hub."},"hubPublisherUID":{"type":"string","description":"FME Hub Publisher UID used for publishing to FME Hub."},"description":{"type":"string","description":"Description of the project."},"readme":{"type":"string","description":"Readme of the project. The readme should be in markdown format."},"version":{"type":"string","description":"Version of the project."},"lastUpdated":{"type":"string","description":"The date/time the project was last updated.","format":"date-time"},"owner":{"type":"string","description":"The owner of the project."},"ownerID":{"type":"string","description":"The UUID of the project owner.","format":"uuid"},"shareable":{"type":"boolean","description":"Whether the project is shareable or not."},"lastUpdateUser":{"type":"string","description":"The name of the user who last updated the project."},"lastUpdateUserID":{"type":"string","description":"The UUID of the user who last updated the project.","format":"uuid"},"hasIcon":{"type":"boolean","description":"Whether the project has a custom icon."}},"description":"Items in this results page"},"DataVirtualizationApiCachingRequest":{"required":["cacheEnabled","cacheExpiryInSeconds"],"type":"object","properties":{"cacheEnabled":{"type":"boolean","description":"Whether caching is enabled"},"cacheExpiryInSeconds":{"type":"integer","description":"Cache expiry in seconds","format":"int64"}},"description":"Caching configuration for the API"},"NewRoleRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Unique name of the role to create."},"accounts":{"uniqueItems":true,"type":"array","description":"Accounts to assign to the role.","items":{"type":"string","description":"Accounts to assign to the role.","format":"uuid"}}}},"TestEventGridSubscriptionRequest":{"required":["eventType","subject","subscriberName","topicEndpoint","topicKey"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"topicEndpoint":{"type":"string","description":"The topic endpoint of the Azure Event Grid Topic"},"topicKey":{"type":"string","description":"The topic access key used to publish events to the Azure Event Grid Topic"},"subject":{"type":"string","description":"The subject used for filtering and routing events"},"eventType":{"type":"string","description":"The event type of the specified subject"},"data":{"type":"string","description":"The event data, specified in key/value pairs, that is published to the specified Azure Event Grid Topic Endpoint."}}}]},"LicenseStatusResponse":{"type":"object","properties":{"licensed":{"type":"boolean","description":"Whether FME Flow is currently licensed"},"expiration":{"type":"string","description":"Expiry date of the license"},"maximumEngines":{"type":"integer","description":"Maximum number of engines allowed with the license","format":"int64"},"expired":{"type":"boolean","description":"Whether the license has expired"},"serialNumber":{"type":"string","description":"Serial number of the license"},"maximumAuthors":{"type":"integer","description":"Maximum number of authoring seats allowed with the license","format":"int64"}}},"DependencyItemType":{"type":"string","enum":["automation","automationApp","galleryApp","schedule","stream","token","workspace","workspaceApp"]},"TestEmailSubscriptionRequest":{"required":["emailContentType","emailFrom","emailSubject","emailTo","smtpServer","smtpServerPort","smtpServerSecurity","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"smtpServer":{"type":"string","description":"The mail exchange server domain name or IP address"},"smtpServerPort":{"type":"integer","description":"The mail exchange TCP port","format":"int32","example":25},"smtpServerAccount":{"type":"string","description":"The username when SMTP server requires authentication"},"smtpServerPassword":{"type":"string","description":"The user or app password when SMTP server requires authentication"},"smtpServerSecurity":{"type":"string","description":"The encryption mechanism used for the connection","enum":["sslTls","startTls","none"]},"emailTo":{"type":"array","description":"The Email recipient(s)","items":{"type":"string","description":"The Email recipient(s)"}},"emailCc":{"type":"array","description":"The Email cc recipient(s)","items":{"type":"string","description":"The Email cc recipient(s)"}},"emailBcc":{"type":"array","description":"The Email bcc recipient(s)","items":{"type":"string","description":"The Email bcc recipient(s)"}},"emailFrom":{"type":"string","description":"The \"From\" field in standard Email messages. If users reply to the notification email, it is directed to this address."},"emailSubject":{"type":"string","description":"The subject of the Email"},"emailContentType":{"type":"string","description":"The format of the Email","enum":["text","html","richText"]},"emailAttachment":{"type":"array","description":"The path to the source file to attach to the Email","items":{"type":"string","description":"The path to the source file to attach to the Email"}},"emailTemplate":{"type":"string","description":"The message body to use for delivery. See documentation for supported tags."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"LicenseRequestStatusResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the license file installation","enum":["uninitialized","requesting","success","failure"]},"message":{"type":"string","description":"The status message of the license file installation"}}},"DataVirtualizationApiPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DataVirtualizationApiResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TopicMonitoringHostRequest":{"required":["host"],"type":"object","properties":{"host":{"type":"string","description":"The external websocket host to set."}}},"GenericLdapServerResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the LDAP server","format":"uuid"},"serverStatus":{"$ref":"#/components/schemas/ServerStatusResponse"},"name":{"type":"string","description":"Name of the LDAP server"},"host":{"type":"string","description":"LDAP server host"},"port":{"type":"integer","description":"LDAP server port","format":"int32"},"encryption":{"type":"string","description":"Encryption mode","enum":["none","ssl","startTls"]},"authentication":{"type":"string","description":"Authentication mechanism","enum":["basic","sasl","sso"]},"connectionOptions":{"$ref":"#/components/schemas/LdapServerConnectionOptionsResponse"},"saslAuthenticationProperties":{"$ref":"#/components/schemas/SaslAuthenticationPropertiesResponse"},"searchProperties":{"$ref":"#/components/schemas/SearchPropertiesResponse"},"syncOptions":{"$ref":"#/components/schemas/SyncOptionsResponse"},"lastSync":{"type":"string","description":"Date and time when LDAP server was last synchronized","format":"date-time"},"lookupAttributes":{"$ref":"#/components/schemas/GenericLookupAttributesResponse"},"searchObjectClasses":{"$ref":"#/components/schemas/LdapServerObjectClassesResponse"}},"description":"Items in this results page"},"UpdateSqsSubscriptionRequest":{"required":["accessKeyID","queue","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"queue":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to which you want to send messages"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"contentTemplate":{"type":"string","description":"The default message to send to the Amazon Web Services (AWS) SQS Queue. Can be up to 64 KB of text in any format."}}}]},"UpdatePublicationRequest":{"required":["publisherName"],"type":"object","properties":{"publisherName":{"type":"string","description":"The communication protocol used for the publication. Publisher cannot be updated.","enum":["sqs","dropboxwatch","dirwatch","eventgrid","sns","s3watch","ftpwatch","jms","smtp","websocket","udp","imap"]},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}}},"discriminator":{"propertyName":"publisherName"}},"PackageResponse":{"type":"object","properties":{"uid":{"type":"string","description":"Unique identifier of the package"},"publisherUID":{"type":"string","description":"Unique identifier of the publisher"},"name":{"type":"string","description":"Name of the package"},"version":{"type":"string","description":"Version number of the package"},"filename":{"type":"string","description":"Filename of the package"},"sizeBytes":{"type":"integer","description":"Size of the package in bytes","format":"int64"},"created":{"type":"string","description":"Timestamp of package creation","format":"date-time"},"lastUpdated":{"type":"string","description":"Timestamp of most recent package update","format":"date-time"}},"description":"Items in this results page"},"TokenItemPermissionRequest":{"required":["id","permissions"],"type":"object","properties":{"id":{"type":"string","description":"UUID of the token","format":"uuid"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}},"description":"Token permissions granted for this item"},"UpdateS3SubscriptionRequest":{"required":["accessKeyID","bucket","encryption","permission","subscriberName","version"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The name of the Amazon Web Services (AWS) S3 Bucket to which you want to upload"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"encryption":{"type":"string","description":"Whether to enable Amazon Web Services (AWS) S3 Server-Side Encryption. When enabled, S3 encrypts your data using AES-256 encryption mode.","enum":["none","sse"]},"permission":{"type":"string","description":"The predefined set of grantees and permissions to store with each uploaded object","enum":["privatePermission","publicRead","publicWrite","authRead","bucketRead","bucketFull"]},"version":{"type":"string","description":"Whether to enable versioning for the specified Amazon Web Services (AWS) S3 Bucket. To maintain the current behavior, or if you do not have permission to set S3 Bucket versioning, leave as \"Default\".","enum":["yes","no","defaultVersioning"]},"localSourcePath":{"type":"string","description":"The path to the file/folder to be uploaded. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The location in the specified Amazon Web Services (AWS) S3 Bucket to upload objects to, using forward slashes (/). If left blank, objects are uploaded to the S3 Bucket’s root."}}}]},"UpdateProjectRequest":{"required":["description","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the project."},"description":{"type":"string","description":"The description of the project."},"readme":{"type":"string","description":"The readme for the project. The readme should be in markdown format."},"version":{"type":"string","description":"The version of the project."},"hubUID":{"type":"string","description":"Project UID used for publishing to FME Hub."},"hubPublisherUID":{"type":"string","description":"FME Hub Publisher UID used for publishing to FME Hub."}}},"CleanupTaskEnableRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled/Disabled state of the cleanup task"}}},"UpdatePasswordPolicyRequest":{"required":["enabled","lowercaseRequired","minimumLength","mustNotContainUsername","specialCharacterOrDigitRequired","uppercaseRequired"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether password complexity rules are applied"},"minimumLength":{"type":"integer","description":"Minimum length of a password","format":"int32"},"uppercaseRequired":{"type":"boolean","description":"Indicates whether uppercase characters are required"},"lowercaseRequired":{"type":"boolean","description":"Indicates whether lowercase characters are required"},"specialCharacterOrDigitRequired":{"type":"boolean","description":"Indicates whether special characters or digits are required"},"mustNotContainUsername":{"type":"boolean","description":"Indicates whether the account username can be contained within a password"}}},"NewSqsPublicationRequest":{"required":["accessKeyID","deleteMessageAfterReceived","name","publisherName","queueUrl","secretAccessKey","visibilityTimeout"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"queueUrl":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to pull messages from"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"deleteMessageAfterReceived":{"type":"boolean","description":"Whether to automatically delete the message after it has been received"},"visibilityTimeout":{"maximum":43200,"minimum":0,"type":"integer","description":"The visibility timeout (in seconds) for the Amazon Web Services (AWS) SQS Queue","format":"int32"}}}]},"UpdateEmailSubscriptionRequest":{"required":["emailContentType","emailFrom","emailSubject","emailTo","smtpServer","smtpServerPort","smtpServerSecurity","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"smtpServer":{"type":"string","description":"The mail exchange server domain name or IP address"},"smtpServerPort":{"type":"integer","description":"The mail exchange TCP port","format":"int32","example":25},"smtpServerAccount":{"type":"string","description":"The username when SMTP server requires authentication"},"smtpServerPassword":{"type":"string","description":"The user or app password when SMTP server requires authentication"},"smtpServerSecurity":{"type":"string","description":"The encryption mechanism used for the connection","enum":["sslTls","startTls","none"]},"emailTo":{"type":"array","description":"The Email recipient(s)","items":{"type":"string","description":"The Email recipient(s)"}},"emailCc":{"type":"array","description":"The Email cc recipient(s)","items":{"type":"string","description":"The Email cc recipient(s)"}},"emailBcc":{"type":"array","description":"The Email bcc recipient(s)","items":{"type":"string","description":"The Email bcc recipient(s)"}},"emailFrom":{"type":"string","description":"The \"From\" field in standard Email messages. If users reply to the notification email, it is directed to this address."},"emailSubject":{"type":"string","description":"The subject of the Email"},"emailContentType":{"type":"string","description":"The format of the Email","enum":["text","html","richText"]},"emailAttachment":{"type":"array","description":"The path to the source file to attach to the Email","items":{"type":"string","description":"The path to the source file to attach to the Email"}},"emailTemplate":{"type":"string","description":"The message body to use for delivery. See documentation for supported tags."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"NewWorkspaceSubscriptionRequest":{"required":["name","repository","subscriberName","workspace"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"repository":{"type":"string","description":"The repository in which the Workspace resides"},"workspace":{"type":"string","description":"The Workspace to subscribe to"},"queue":{"type":"string","description":"The queue in which to run the job"},"maxTimeInQueue":{"type":"integer","description":"The length of time after which a job that is waiting in queue does not execute","format":"int32"},"maxJobRuntime":{"minimum":1,"type":"integer","description":"The time a job will remain in the running state","format":"int32"},"runUntilCancelled":{"type":"boolean","description":"Whether to run the job continuously forever, until explicitly cancelled"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"publishedReaderOverride":{"type":"string","description":"The source dataset published parameter"},"publishedWriterForNotification":{"type":"string","description":"The destination dataset published parameter"}}}]},"TestExistingSubscriptionRequest":{"required":["subscriberName"],"type":"object","properties":{"subscriberName":{"type":"string","description":"The communication protocol used for the subscription","enum":["httprequest","sqs","logger","ftp","eventgrid","sns","workspace","dropbox","jms","sftp","s3","email","websocket"]}},"discriminator":{"propertyName":"subscriberName"}},"TokenItemPermissionResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the token","format":"uuid"},"account":{"type":"string","description":"Name of the account"},"name":{"type":"string","description":"Name of the token"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}},"description":"Token permissions granted for this item"},"UpdateDropboxSubscriptionRequest":{"required":["localSourcePath","remoteUploadDirectory","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"SharedResourceFileInfoResponse":{"type":"object","properties":{"name":{"type":"string","description":"File or directory name"},"type":{"type":"string","description":"Type of item","enum":["file","directory"]},"date":{"type":"string","description":"File or directory creation or modification date","format":"date-time"},"path":{"type":"string","description":"Filesystem path relative to the resource connection root"},"size":{"type":"integer","description":"Size of the regular file in bytes","format":"int64"},"contents":{"type":"array","description":"The directory contents (files and sub-directories)","items":{"$ref":"#/components/schemas/SharedResourceFileInfoResponse"}}}},"StreamsEnableRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled/Disabled state of the stream"}}},"SaslAuthenticationPropertiesRequest":{"required":["saslMechanism"],"type":"object","properties":{"saslMechanism":{"type":"string","description":"SASL authentication mechanism. Required when 'authentication' is set to SASL or SSO","enum":["gssapi","external"]},"kdcAddress":{"type":"string","description":"Host address of the Key Distribution Center (KDC), used when 'authentication' is set to SASL or SSO and 'saslMechanism' is set to 'GSSAPI'. If omitted, the 'host' attribute is used"},"realm":{"type":"string","description":"Authentication realm name, used when 'authentication' is set to SASL or SSO and 'saslMechanism' is set to 'GSSAPI'. If omitted, the capitalized version of the domain name in the 'host' attribute is used"},"channelBinding":{"type":"boolean","description":"Channel Binding. Used for SSL/TLS connections and 'authentication' is set to SASL and 'saslMechanism' is set to 'GSSAPI'. True if LDAP server requires channel binding."}},"description":"Properties used for SASL authentication"},"DataVirtualizationEndpointAsyncRequest":{"required":["inheritAsyncProcessing"],"type":"object","properties":{"inheritAsyncProcessing":{"type":"boolean","description":"Whether the endpoint will inherit the asynchronous processing configuration of the API"},"asyncEnabled":{"type":"boolean","description":"Whether asynchronous processing is enabled. If inheritAsyncProcessing is false, asyncEnabled must be specified."},"asyncResultExpiryInSeconds":{"type":"integer","description":"Asynchronous result data expiry in seconds. If inheritAsyncProcessing is false, asyncResultExpiryInSeconds must be specified.","format":"int64"}}},"DetailedQueueResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the queue"},"description":{"type":"string","description":"Description of the queue"},"priority":{"type":"integer","description":"Priority of the queue. Priority must be between 1 to 10, where 10 is the highest priority. Queues with higher priority will submit jobs to run first.","format":"int32"},"type":{"type":"string","description":"The type of queue","enum":["system","remote"]},"runningJobCount":{"type":"integer","description":"The number of running jobs","format":"int32"},"successfulJobCount":{"type":"integer","description":"The number of successful jobs since the last queue statistics reset","format":"int64"},"failedJobCount":{"type":"integer","description":"The number of failed jobs since the last queue statistics reset","format":"int64"},"cancelledJobCount":{"type":"integer","description":"The number of cancelled jobs since the last queue statistics reset","format":"int64"},"queuedJobCount":{"type":"integer","description":"The number of queued jobs","format":"int32"},"totalCompletedJobQueuedTime":{"type":"integer","description":"The total time (in milliseconds) that completed jobs were queued since the last queue statistics reset","format":"int64"},"averageCompletedJobQueuedTime":{"type":"integer","description":"The average time (in milliseconds) that completed jobs were queued since the last queue statistics reset","format":"int64"},"totalCompletedJobRunTime":{"type":"integer","description":"The total time (in milliseconds) that completed jobs were run since the last queue statistics reset","format":"int64"},"averageCompletedJobRunTime":{"type":"integer","description":"The average time (in milliseconds) that completed jobs were run since the last queue statistics reset","format":"int64"},"statisticsLastReset":{"type":"string","description":"Indicates the most recent reset of queue statistics","format":"date-time"},"assignedEngines":{"type":"array","description":"The engines assigned to the queue","items":{"type":"string","description":"The engines assigned to the queue"}},"default":{"type":"boolean","description":"Whether the queue is the default queue"}},"description":"Items in this results page"},"ProjectItemResponse":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the item. May be the item's UUID, name, or a combination of the file path and name."},"name":{"type":"string","description":"The name of the item."},"type":{"$ref":"#/components/schemas/ProjectItemType"},"owner":{"type":"string","description":"The owner of the item. Note that not all items have an owner."},"lastUpdated":{"type":"string","description":"The date/time the item was last updated.","format":"date-time"},"dependencies":{"type":"array","description":"The dependencies of the item.","items":{"$ref":"#/components/schemas/DependencyResponse"}}},"description":"Items in this results page"},"OrderJobRuleRequest":{"required":["id1","id2","order1","order2"],"type":"object","properties":{"id1":{"type":"string","description":"ID of the job routing rule for first rule","format":"uuid"},"order1":{"type":"integer","description":"Order identifier for first rule","format":"int64"},"id2":{"type":"string","description":"ID of the job routing rule for second rule","format":"uuid"},"order2":{"type":"integer","description":"Order identifier for second rule","format":"int64"}}},"ScheduleSummaryPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ScheduleSummaryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"CleanupSystemTaskResponse":{"type":"object","properties":{"maxAgeInSeconds":{"type":"integer","description":"Maximum age (seconds) of jobs, system events, tokens, or automation logs to keep before cleaning","format":"int64"},"description":{"type":"string","description":"Description of the cleanup task"},"enabled":{"type":"boolean","description":"Whether the cleanup task is currently enabled or disabled"},"type":{"type":"string","description":"The type of task (jobs, system events, tokens, or automation logs)","enum":["jobs","systemEvents","tokens","automationLogs"]}},"description":"Items in this results page"},"UserPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/EntraIDUserResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewAccountRequest":{"required":["enabled","fullName","name","password","passwordChangeNeeded","sharingEnabled"],"type":"object","properties":{"name":{"type":"string","description":"Unique name of the account to create."},"fullName":{"type":"string","description":"Full name of the account user."},"email":{"type":"string","description":"Email of the account user."},"password":{"type":"string","description":"Password for the account."},"roles":{"uniqueItems":true,"type":"array","description":"Roles to assign to the account.","items":{"type":"string","description":"Roles to assign to the account.","format":"uuid"}},"enabled":{"type":"boolean","description":"Specifies whether the account is enabled or not"},"sharingEnabled":{"type":"boolean","description":"Specifies whether the account is allowed to share items with other users and roles."},"passwordChangeNeeded":{"type":"boolean","description":"Specifies whether a password is required to be changed on the next login."}}},"UserResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the LDAP user"},"fullName":{"type":"string","description":"Full name of the LDAP user"},"distinguishedName":{"type":"string","description":"Distinguished name of the LDAP user"},"email":{"type":"string","description":"Email address of the LDAP user"},"authenticationID":{"type":"string","description":"Authentication ID of the LDAP user"},"linkedAccountName":{"type":"string","description":"Linked account name"},"server":{"type":"string","description":"Name of the LDAP server"}}},"SsoPropertiesResponse":{"type":"object","properties":{"username":{"type":"string","description":"Kerberos authentication ID of service account used for single sign-on authentication."},"password":{"type":"string","description":"Password of service account used for single sign-on authentication."}},"description":"SSO user properties"},"EnablePasswordExpirationRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether a password should expire after a specified number of days"}}},"BatchNewProjectItemRequest":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/NewProjectItemRequest"}}}},"TestConnectionStatusResponse":{"type":"object","properties":{"status":{"type":"integer","description":"Status code of the connection test","format":"int32"},"success":{"type":"boolean","description":"Whether or not connection test was a success"},"message":{"type":"string","description":"Additional details when connection test fails"}}},"AllowedUserResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the user","format":"uuid"},"name":{"type":"string","description":"Name of the user"}},"description":"IDs of users that are authorized to run endpoints in this API"},"RepositoryPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/RepositoryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdateWindowsLdapServerRequest":{"required":["authentication","connectionOptions","encryption","host","port"],"type":"object","properties":{"host":{"type":"string","description":"LDAP server host"},"port":{"type":"integer","description":"LDAP server port","format":"int32"},"encryption":{"type":"string","description":"Encryption mode","enum":["none","ssl","startTls"]},"connectionOptions":{"$ref":"#/components/schemas/LdapServerConnectionOptionsUpdateRequest"},"authentication":{"type":"string","description":"Authentication mechanism","enum":["basic","sasl","sso"]},"saslAuthenticationProperties":{"$ref":"#/components/schemas/SaslAuthenticationPropertiesRequest"},"searchProperties":{"$ref":"#/components/schemas/SearchPropertiesRequest"},"syncOptions":{"$ref":"#/components/schemas/SyncOptionsRequest"},"lookupAttributes":{"$ref":"#/components/schemas/WindowsLookupAttributesRequest"},"ssoProperties":{"$ref":"#/components/schemas/UpdateSsoPropertiesRequest"}}},"DeleteRequest":{"required":["items","path"],"type":"object","properties":{"path":{"type":"string","description":"Directory, relative to the resource connection (for example, /foo/bar)."},"items":{"type":"array","description":"List of up to 500 file or folder names.","items":{"type":"string","description":"List of up to 500 file or folder names."}}}},"NewTokenConnectionRequest":{"required":["category","name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewConnectionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token value"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format (e.g., 2025-01-01T12:00-08:00).","format":"date-time"},"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters for the token connection"},"description":"The parameters for the token connection"}}}]},"TestExistingFtpSubscriptionRequest":{"required":["connectionType","encryption","host","port","subscriberName","transferType","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"transferType":{"type":"string","description":"The transfer method","enum":["auto","ascii","binary"]},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"DataVirtualizationApiJobExpiryRequest":{"required":["jobExpiryInSeconds"],"type":"object","properties":{"jobExpiryInSeconds":{"type":"integer","description":"Job expiry in seconds","format":"int64"}}},"LicenseRequest":{"required":["email","firstName","lastName","serialNumber","subscribeToUpdates"],"type":"object","properties":{"jobTitle":{"type":"string","description":"Job title"},"company":{"type":"string","description":"Company"},"industry":{"type":"string","description":"Industry"},"email":{"type":"string","description":"Email address"},"firstName":{"type":"string","description":"First Name"},"lastName":{"type":"string","description":"Last Name"},"serialNumber":{"type":"string","description":"Serial number"},"subscribeToUpdates":{"type":"boolean","description":"Subscribe to updates"}}},"RoleAccountAssignmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the account","format":"uuid"},"name":{"type":"string","description":"Name of the account"}},"description":"Roles assigned to the account"},"ProxyConfigRequest":{"required":["enabled","host","nonProxyHosts","port","requiresAuthentication","scheme"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the proxy is enabled or not"},"host":{"type":"string","description":"The proxy host"},"nonProxyHosts":{"type":"array","description":"The lists of hosts that will be accessed without without a proxy","items":{"type":"string","description":"The lists of hosts that will be accessed without without a proxy"}},"port":{"type":"integer","description":"The proxy port","format":"int32"},"scheme":{"type":"string","description":"The proxy scheme"},"requiresAuthentication":{"type":"boolean","description":"Whether the proxy requires authentication or not"},"credentials":{"$ref":"#/components/schemas/ProxyCredentialsRequest"}},"description":"Proxy configuration for the Remote Engine."},"GenerateTokenRequest":{"required":["namePrefix","secondsToExpiry"],"type":"object","properties":{"namePrefix":{"type":"string","description":"Prefix of the token name"},"secondsToExpiry":{"type":"integer","description":"Expiration timeout in seconds for the token","format":"int64"}}},"EngineHostPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/EngineHostResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"SystemEventsConfigurationEnabledRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the configuration is enabled (true) or disabled (false)"}}},"TestExistingSnsSubscriptionRequest":{"required":["accessKeyID","subscriberName","topicArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"topicArn":{"type":"string","description":"The ARN of the Amazon Web Services (AWS) SNS Topic"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SNS Topic"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SNS Topic"},"subject":{"type":"string","description":"The subject of the Amazon Web Services (AWS) SNS Topic"},"contentTemplate":{"type":"string","description":"The default message to publish to the Amazon Web Services (AWS) SNS Topic. Can be up to 64 KB of Unicode text."}}}]},"MachineKeyResponse":{"type":"object","properties":{"machineKey":{"type":"string","description":"The unique machine key associated with the machine running FME Flow"}}},"TestExistingSmtpPublicationRequest":{"required":["emailUserName","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"emailUserName":{"type":"string","description":"The username of the email address on the FME Flow host system that receives the notification email. For example, if the FME Flow host name is services.internal, and the email address is user@services.internal, enter user."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."}}}]},"EnablePasswordResetResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether FME Flow password reset is enabled (true) or disabled (false)"}}},"MigrationRestoreUploadRequest":{"required":["overwrite","pauseNotifications"],"type":"object","properties":{"overwrite":{"type":"boolean","description":"Whether the system restore should overwrite items if they already exist"},"pauseNotifications":{"type":"boolean","description":"Whether the system restore should pause FME Flow notifications"},"successTopic":{"type":"string","description":"Topic to notify on successful system restore"},"failureTopic":{"type":"string","description":"Topic to notify on failed system restore"}},"description":"Parameters for the system restore."},"UpdateDropboxWatchPublicationRequest":{"required":["eventsToWatchFor","path","publisherName","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"path":{"type":"string","description":"The location on your Dropbox account to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"Lod":{"type":"object","properties":{"minLodPixels":{"type":"integer","description":"Show features when bounding box is larger than square, in pixels","format":"int32"},"maxLodPixels":{"type":"integer","description":"Hide features when bounding box is larger than square, in pixels (-1 for disabled)","format":"int32"}},"description":"Level of detail that determines visibility"},"DeploymentParameterRequest":{"required":["name","type"],"type":"object","properties":{"name":{"maxLength":255,"minLength":0,"type":"string","description":"Name of the parameter"},"value":{"type":"string","description":"Value assigned to the parameter"},"type":{"type":"string","description":"The type of the parameter","enum":["text","dropdown","password"]}},"discriminator":{"propertyName":"type"}},"UpdateSubscriptionRequest":{"required":["subscriberName"],"type":"object","properties":{"subscriberName":{"type":"string","description":"The subscription protocol of the subscription. Subscriber cannot be updated.","enum":["httprequest","sqs","logger","ftp","eventgrid","sns","workspace","dropbox","jms","sftp","s3","email","websocket"]},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}}},"discriminator":{"propertyName":"subscriberName"}},"DownloadResourceFilesRequest":{"required":["items","path","zipFileName"],"type":"object","properties":{"path":{"type":"string","description":"Path, relative to the resource connection (for example, /foo/bar/test.file)."},"items":{"type":"array","description":"List of up to 500 file or folder names to be downloaded.","items":{"type":"string","description":"List of up to 500 file or folder names to be downloaded."}},"zipFileName":{"type":"string","description":"Name of the downloaded zipped file."}}},"WindowsLdapServerResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the LDAP server","format":"uuid"},"serverStatus":{"$ref":"#/components/schemas/ServerStatusResponse"},"name":{"type":"string","description":"Name of the LDAP server"},"host":{"type":"string","description":"LDAP server host"},"port":{"type":"integer","description":"LDAP server port","format":"int32"},"encryption":{"type":"string","description":"Encryption mode","enum":["none","ssl","startTls"]},"authentication":{"type":"string","description":"Authentication mechanism","enum":["basic","sasl","sso"]},"connectionOptions":{"$ref":"#/components/schemas/LdapServerConnectionOptionsResponse"},"saslAuthenticationProperties":{"$ref":"#/components/schemas/SaslAuthenticationPropertiesResponse"},"searchProperties":{"$ref":"#/components/schemas/SearchPropertiesResponse"},"syncOptions":{"$ref":"#/components/schemas/SyncOptionsResponse"},"lastSync":{"type":"string","description":"Date and time when LDAP server was last synchronized","format":"date-time"},"lookupAttributes":{"$ref":"#/components/schemas/WindowsLookupAttributesResponse"},"ssoProperties":{"$ref":"#/components/schemas/SsoPropertiesResponse"}},"description":"Items in this results page"},"UpdateLoggerSubscriptionRequest":{"required":["logLevel","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"logLevel":{"type":"string","description":"The level of detail of the notification message in the log file","enum":["low","normal","high"]}}}]},"UpdateEventGridSubscriptionRequest":{"required":["eventType","subject","subscriberName","topicEndpoint"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"topicEndpoint":{"type":"string","description":"The topic endpoint of the Azure Event Grid Topic"},"topicKey":{"type":"string","description":"The topic access key used to publish events to the Azure Event Grid Topic"},"subject":{"type":"string","description":"The subject used for filtering and routing events"},"eventType":{"type":"string","description":"The event type of the specified subject"},"data":{"type":"string","description":"The event data, specified in key/value pairs, that is published to the specified Azure Event Grid Topic Endpoint."}}}]},"HttpSubscriptionResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the subscription","format":"uuid"},"owner":{"type":"string","description":"Owner of the subscription"},"name":{"type":"string","description":"Name of the subscription"},"subscriberName":{"type":"string","description":"The communication protocol used for the subscription"},"shareable":{"type":"boolean","description":"Whether the subscription is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"requestType":{"type":"string","description":"The type of HTTP request","enum":["get","post","put","delete"]},"url":{"type":"string","description":"The URL to which notifications on the associated topics are delivered via HTTP POST"},"httpUsername":{"type":"string","description":"The username when the target URL requires HTTP authentication"},"httpPassword":{"type":"string","description":"The user password when the target URL requires HTTP authentication"},"acceptHeader":{"type":"string","description":"Format of the Accept request HTTP header: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"contentType":{"type":"string","description":"The format in which to deliver content: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"contentTemplate":{"type":"string","description":"The message body content. If specified, this message replaces the incoming message body."}}},"PasswordRequest":{"required":["currentPassword","newPassword"],"type":"object","properties":{"currentPassword":{"type":"string","description":"Old password of the user account"},"newPassword":{"type":"string","description":"New password of the user account"}}},"NewDropboxWatchPublicationRequest":{"required":["accessToken","eventsToWatchFor","name","path","publisherName","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"path":{"type":"string","description":"The location on your Dropbox account to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"FtpWatchPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32"},"username":{"type":"string","description":"The FTP user name for authentication"},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"path":{"type":"string","description":"The location on the FTP server to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified FTP server to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}},"UpdatePasswordRequestSnowflake":{"required":["currentPassword","newPassword","snowflakeAuthentication","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePasswordRequest"},{"type":"object","properties":{"snowflakeAuthentication":{"$ref":"#/components/schemas/NewSnowflakeAuthRequest"}}}]},"TestImapPublicationRequest":{"required":["fetchOption","filterType","imapAccount","imapPassword","imapPort","imapSecurity","imapServer","pollInterval","publisherName","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"imapServer":{"type":"string","description":"The mail exchange server domain name or IP address used for receiving email"},"imapPort":{"type":"integer","description":"The mail exchange TCP port used for receiving email","format":"int32","example":993},"imapAccount":{"type":"string","description":"The email account used for receiving email over IMAP. IMAP access must be enabled on this account. You cannot create multiple IMAP Publishers that reference the same address."},"imapPassword":{"type":"string","description":"The email account password used for receiving email over IMAP"},"imapSecurity":{"type":"string","description":"The encryption mechanism used for the IMAP connection","enum":["sslTls","startTls","none"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified IMAP server for email","format":"int32"},"fetchOption":{"type":"string","description":"Whether to fetch all unread messages from the inbox or only messages received after the previous fetch","enum":["newEmailsOnly","unreadEmails"]},"filterType":{"type":"string","description":"The filter, case-insensitive string match or regular expression, against the email subject line","enum":["simple","regex"]},"subjectFilter":{"type":"string","description":"Only fetch messages where the subject satisfies the filter. Wildcard characters are not supported. If the filter is left blank, then all unread/new messages will be fetched."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"EncryptionKeyResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the encryption key"},"usedForDecryption":{"type":"boolean","description":"Indicates if the encryption key is used for decryption"},"usedForEncryption":{"type":"boolean","description":"Indicates if the encryption key is used for encryption"}},"description":"The list of encryption keys"},"NewJobRequest":{"required":["repository","workspace"],"type":"object","properties":{"directives":{"type":"object","additionalProperties":{"type":"string","description":"Additional NM Directives, which can include client-configured keys, to pass to the notification service for custom use by subscriptions"},"description":"Additional NM Directives, which can include client-configured keys, to pass to the notification service for custom use by subscriptions"},"failureTopics":{"type":"array","description":"Topics to notify when the job fails","items":{"type":"string","description":"Topics to notify when the job fails"}},"successTopics":{"type":"array","description":"Topics to notify when the job succeeds","items":{"type":"string","description":"Topics to notify when the job succeeds"}},"maxJobRuntime":{"type":"integer","description":"Time (in seconds) elapsed for a running job before it's cancelled. The minimum value is 1 second, values less than 1 second are ignored.","format":"int64"},"maxTimeInQueue":{"type":"integer","description":"Time to live in the job queue (in seconds)","format":"int64"},"queue":{"type":"string","description":"The queue for the request"},"repository":{"type":"string","description":"The repository of the job to run"},"workspace":{"pattern":".*.(?i)fmw","type":"string","description":"The workspace of the job to run"},"publishedParameters":{"type":"object","additionalProperties":{"type":"object","description":"Published parameters of the job requests"},"description":"Published parameters of the job requests"}}},"DataVirtualizationEndpointJobExpiryResponse":{"type":"object","properties":{"inheritJobExpiry":{"type":"boolean","description":"Whether the endpoint will inherit the job expiry configuration of the API"},"jobExpiryInSeconds":{"type":"integer","description":"Job expiry in seconds. If inheritJobExpiry is false, jobExpiryInSeconds must be specified.","format":"int64"}},"description":"Job expiry configuration of the endpoint"},"ImportSettingsRequest":{"type":"object","properties":{"fallbackOwnerID":{"type":"string","format":"uuid"},"overwrite":{"type":"boolean"},"pauseNotifications":{"type":"boolean"},"disableItems":{"type":"boolean"},"notification":{"$ref":"#/components/schemas/NotificationOptions"},"selectedItems":{"type":"array","items":{"$ref":"#/components/schemas/ItemId"}}}},"UpdateEnginesConfigRequest":{"required":["maxJobRetries","maxQueueCount"],"type":"object","properties":{"maxQueueCount":{"minimum":-1,"type":"integer","description":"Maximum number of assigned queues per engine. Should be 1 or greater, otherwise -1 means unlimited.","format":"int32"},"maxJobRetries":{"minimum":-1,"type":"integer","description":"Maximum number of times a failed transaction request will be automatically resubmitted for processing,\nafter which the failed request is cancelled.\n\nA value of -1 means that no maximum limit is imposed, and failed transaction requests will be\nautomatically resubmitted indefinitely.\n\nA value of 0 means that automatic resubmission is disabled.","format":"int32"}}},"ItemPermissionsPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/ItemPermissionsResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"PasswordResetPropertiesResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether FME Flow password reset is enabled (true) or disabled (false)"},"emailSubject":{"type":"string","description":"Email Subject"},"publicUrl":{"type":"string","description":"Public URL for FME Flow. The link sent in the password reset email will be based on this public URL."}}},"MigrationLogLine":{"type":"object","properties":{"number":{"type":"integer","description":"Line number","format":"int64"},"time":{"type":"string","description":"Time stamp","format":"date-time"},"status":{"type":"string","description":"Status"},"message":{"type":"string","description":"Message"},"line":{"type":"string","description":"Raw log line"}},"description":"Items in this results page"},"TopicResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the topic","format":"uuid"},"owner":{"type":"string","description":"Owner of the topic"},"name":{"type":"string","description":"Name of the topic"},"description":{"type":"string","description":"A human-readable description of the topic"},"shareable":{"type":"boolean","description":"Whether the topic is shareable or not"}},"description":"Items in this results page"},"AccountRoleAssignmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the role","format":"uuid"},"name":{"type":"string","description":"Name of the role"}},"description":"Roles assigned to the account"},"UpdateActivePeriodRequest":{"required":["description","endTime","name","recurrence","startTime"],"type":"object","properties":{"name":{"type":"string","description":"Name of active period"},"description":{"type":"string","description":"Description of active period"},"startDate":{"type":"string","description":"Start date of active period","format":"date-time"},"endDate":{"type":"string","description":"End date of active period","format":"date-time"},"startTime":{"type":"string","description":"Start time of active period","format":"date-time"},"endTime":{"type":"string","description":"End time of active period","format":"date-time"},"recurrence":{"type":"string","description":"Recurrence configuration of active period"},"engineRules":{"type":"array","description":"Engine rules to assign to the active period","items":{"type":"string","description":"Engine rules to assign to the active period","format":"uuid"}}}},"DataVirtualizationWorkspacePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DataVirtualizationWorkspaceListResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewSmtpPublicationRequest":{"required":["emailUserName","name","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"emailUserName":{"type":"string","description":"The username of the email address on the FME Flow host system that receives the notification email. For example, if the FME Flow host name is services.internal, and the email address is user@services.internal, enter user."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."}}}]},"DataVirtualizationApiSecurityResponse":{"type":"object","properties":{"requireAuthentication":{"type":"boolean","description":"Whether the API requires user authentication to access endpoints"},"allowedUsers":{"type":"array","description":"IDs of users that are authorized to run endpoints in this API","items":{"$ref":"#/components/schemas/AllowedUserResponse"}},"allowedRoles":{"type":"array","description":"IDs of roles that are authorized to run endpoints in this API","items":{"$ref":"#/components/schemas/AllowedRoleResponse"}}},"description":"Security configuration for the API"},"UpdateEventGridPublicationRequest":{"required":["publisherName","webhookEndpoint"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"webhookEndpoint":{"type":"string","description":"The WebHook endpoint from which to receive events. The ID parameter acts as an access token to verify that the event is coming from Azure Event Grid and should be kept private. Azure Event Grid only supports publicly accessible HTTPS webhook endpoints using a valid certificate."}}}]},"UpdateSharedResourceRequest":{"required":["displayName","type"],"type":"object","properties":{"displayName":{"type":"string","description":"Display name of the resource connection"},"description":{"type":"string","description":"Description of the resource connection"},"type":{"type":"string","description":"Type of the resource connection","enum":["file","awsS3","network"]},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Resource type-specific properties"},"description":"Resource type-specific properties"}}},"UpdateSnsPublicationRequest":{"required":["publisherName","subscriptionArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"subscriptionArn":{"type":"string","description":"The Amazon Web Services (AWS) SNS Subscription ID"}}}]},"NewSAMLConfigRequest":{"required":["attributeMap","autoAddNewUsers","defaultRole","enabled","idpDetails","name","signRequests","useMetadataFile"],"type":"object","properties":{"name":{"type":"string","description":"Name of SAML configuration"},"signRequests":{"type":"boolean","description":"Whether the SAML response is encrypted."},"useMetadataFile":{"type":"boolean","description":"Whether the identity provider metadata is used for configuration."},"idpDetails":{"$ref":"#/components/schemas/NewIdentityProviderDetails"},"autoAddNewUsers":{"type":"boolean","description":"Whether new users are automatically added to FME Flow."},"defaultRole":{"type":"string","description":"The default role under which new users are added","format":"uuid"},"attributeMap":{"$ref":"#/components/schemas/AttributeMap"},"enabled":{"type":"boolean","description":"Whether the SAML configuration is enabled"}}},"UpdateTokenConnectionRequest":{"required":["category"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateConnectionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token value"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format (e.g., 2025-01-01T12:00-08:00).","format":"date-time"},"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters for the token connection"},"description":"The parameters for the token connection"}}}]},"ItemPermissionsResponse":{"type":"object","properties":{"category":{"type":"string","description":"Category of the item"},"name":{"type":"string","description":"Name of the item"},"displayName":{"type":"string","description":"Display name of the item"},"ownerName":{"type":"string","description":"Name of the owner"},"ownerID":{"type":"string","description":"UUID of the owner","format":"uuid"},"rolePermissions":{"type":"array","description":"Role permissions granted for this item","items":{"$ref":"#/components/schemas/RoleItemPermissionResponse"}},"accountPermissions":{"type":"array","description":"Account permissions granted for this item","items":{"$ref":"#/components/schemas/AccountItemPermissionResponse"}},"tokenPermissions":{"type":"array","description":"Token permissions granted for this item","items":{"$ref":"#/components/schemas/TokenItemPermissionResponse"}}},"description":"Items in this results page"},"SyncOptionsResponse":{"type":"object","properties":{"enableSync":{"type":"boolean","description":"Specifies whether synchronizing LDAP users and groups is enabled or not"},"syncInterval":{"type":"integer","description":"If enableSync is true, this interval specifies how often to synchronize LDAP users and groups, in seconds","format":"int32"}},"description":"LDAP server synchronization options"},"NewOAuthV2ConnectionRequest":{"required":["category","name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewConnectionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token value"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format (e.g., 2025-01-01T12:00-08:00).","format":"date-time"},"refreshToken":{"type":"string","description":"The refresh token"},"parameters":{"type":"object","additionalProperties":{"type":"string","description":"The parameters for the connection"},"description":"The parameters for the connection"}}}]},"WindowsLookupAttributesResponse":{"type":"object","properties":{"fullName":{"type":"string","description":"Attribute containing the full name of the LDAP user."},"email":{"type":"string","description":"Attribute containing the email address of the LDAP user"},"group":{"type":"string","description":"Attribute containing the name of the LDAP group."},"username":{"type":"string","description":"Attribute containing the name of the LDAP user."}},"description":"Attributes used to fetch user and group details"},"PasswordPolicyResponse":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether password complexity rules are applied"},"minimumLength":{"type":"integer","description":"Minimum length of a password","format":"int32"},"uppercaseRequired":{"type":"boolean","description":"Indicates whether uppercase characters are required"},"lowercaseRequired":{"type":"boolean","description":"Indicates whether lowercase characters are required"},"specialCharacterOrDigitRequired":{"type":"boolean","description":"Indicates whether special characters or digits are required"},"mustNotContainUsername":{"type":"boolean","description":"Indicates whether the account username can be contained within a password"}}},"NewStreamEngineRuleRequest":{"required":["enabled","name","queues","rule","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of engine assignment rule"},"type":{"type":"string","description":"Type of engine assignment rule","enum":["name","property"]},"rule":{"type":"string","description":"Engine assignment rule"},"queues":{"type":"array","description":"Queues to assign engines to","items":{"type":"string","description":"Queues to assign engines to"}},"enabled":{"type":"boolean","description":"Indicates if engine assignment rule is enabled"}}},"TestSftpSubscriptionRequest":{"required":["host","port","remoteUploadDirectory","subscriberName","username","verifyHostKey"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The SFTP host name"},"port":{"type":"integer","description":"The SFTP port number","format":"int32","example":22},"username":{"type":"string","description":"The SFTP username for authentication"},"password":{"type":"string","description":"The SFTP user password for authentication"},"verifyHostKey":{"type":"boolean","description":"Whether to verify the host key for the server being connected to"},"knownHostsFile":{"type":"string","description":"The path to the known_hosts file that contains the public keys for any servers you wish to connect to, if verifying host key. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"localSourcePath":{"type":"string","description":"The source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file"}}}]},"LDAPRoleResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the LDAP user role"},"distinguishedName":{"type":"string","description":"Distinguished name of the LDAP user role"},"memberNames":{"type":"array","description":"Names of the member LDAP user accounts","items":{"type":"string","description":"Names of the member LDAP user accounts"}},"memberDistinguishedNames":{"type":"array","description":"Distinguished names of the LDAP user accounts","items":{"type":"string","description":"Distinguished names of the LDAP user accounts"}},"linkedRoleName":{"type":"string","description":"Linked role name"},"server":{"type":"string","description":"Name of the LDAP server"}}},"TestNewSharedResourceRequest":{"required":["displayName","type"],"type":"object","properties":{"displayName":{"type":"string","description":"Display name of the resource connection"},"description":{"type":"string","description":"Description of the resource connection"},"type":{"type":"string","description":"Type of the resource connection","enum":["file","awsS3","network"]},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Resource type-specific properties"},"description":"Resource type-specific properties"}}},"EngineRulePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/EngineRuleResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"DeploymentParameterPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"oneOf":[{"$ref":"#/components/schemas/DeploymentParameterResponse"},{"$ref":"#/components/schemas/DeploymentParameterDropdownResponse"},{"$ref":"#/components/schemas/DeploymentParameterPasswordResponse"},{"$ref":"#/components/schemas/DeploymentParameterTextResponse"}]}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"CleanupTaskPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/CleanupTaskResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TestLoggerSubscriptionRequest":{"required":["logLevel","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"logLevel":{"type":"string","description":"The level of detail of the notification message in the log file","enum":["low","normal","high"]}}}]},"MultiWebSessionsRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether multiple web sessions are allowed or not"}}},"ImportItemType":{"type":"string","enum":["automation","cleanupTask","connection","customFormat","customTransformer","deploymentParameter","fmepackage","project","publication","repository","resourceConnection","resourcePath","role","schedule","automationApp","galleryApp","workspaceApp","stream","subscription","template","token","topic","user","workspace","dataVirtualizationApi"]},"TestExistingDropboxSubscriptionRequest":{"required":["localSourcePath","remoteUploadDirectory","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The refresh token for the Dropbox account"},"appKey":{"type":"string","description":"The app key associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"ImportUserRequest":{"required":["distinguishedName","username"],"type":"object","properties":{"username":{"type":"string","description":"Name of the FME Flow account"},"distinguishedName":{"type":"string","description":"Distinguished name of the LDAP user"}}},"SystemEventsHistoryResponse":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"type":{"type":"string"},"header":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64"},"body":{"type":"string"}},"description":"Items in this results page"},"TestExistingS3WatchPublicationRequest":{"required":["accessKeyID","bucket","eventsToWatchFor","pollInterval","publisherName","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The Bucket name in the Amazon Web Services (AWS) S3 account, case-sensitive"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"path":{"type":"string","description":"The folder location in the specified Amazon Web Services (AWS) S3 Bucket to watch for changes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified Amazon Web Services (AWS) S3 Bucket. S3 is a pay-per-use service. Every poll is one request to this service.","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"NewProjectRequest":{"required":["description","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the project."},"description":{"type":"string","description":"The description of the project."},"readme":{"type":"string","description":"The readme for the project. The readme should be in markdown format."},"version":{"type":"string","description":"The version of the project."},"hubUID":{"type":"string","description":"Project UID used for publishing to FME Hub."},"hubPublisherUID":{"type":"string","description":"FME Hub Publisher UID used for publishing to FME Hub."}}},"DeleteProjectItemRequest":{"required":["id","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/ProjectItemType"},"id":{"type":"string","description":"A unique identifier for the item. May be the item's UUID, name, or a combination of the file path and name."}},"description":"List of the item types and IDs to be deleted"},"UpdateScheduleRequest":{"required":["enabled","recurrence","repository","skipUntilJobComplete","workspace"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies whether the schedule is enabled or not."},"recurrence":{"type":"string","description":"Type of recurrence, either an interval or a CRON expression","enum":["cron","basic","interval","none"]},"cron":{"type":"string","description":"CRON expression (applies to 'cron' recurrence type)"},"begin":{"type":"string","description":"Date/time the schedule will begin","format":"date-time"},"end":{"type":"string","description":"Date/time the schedule will end and no longer run","format":"date-time"},"interval":{"type":"integer","description":"If `recurrence` is `interval`, the interval size, based on the specified `unit`","format":"int32"},"unit":{"type":"string","description":"If 'recurrence' is 'interval', the unit of interval","enum":["second","minute","hour","day","week","month","year"]},"description":{"type":"string","description":"Description of the schedule"},"skipUntilJobComplete":{"type":"boolean","description":"Option to prevent the schedule from triggering until the last triggered job is complete"},"repository":{"type":"string","description":"Repository containing the workspace to run"},"workspace":{"pattern":".*.(?i)fmw","type":"string","description":"The workspace to run"},"publishedParameters":{"type":"array","description":"The published parameters used to run the workspace","items":{"$ref":"#/components/schemas/PublishedParameter"}},"tags":{"type":"array","description":"Tags associated with the schedule","items":{"type":"string","description":"Tags associated with the schedule"}},"queue":{"type":"string","description":"The job routing queue"},"failureTopics":{"type":"array","description":"Topics to notify when the job fails","items":{"type":"string","description":"Topics to notify when the job fails"}},"successTopics":{"type":"array","description":"Topics to notify when the job succeeds","items":{"type":"string","description":"Topics to notify when the job succeeds"}},"maxJobRuntime":{"minimum":1,"type":"integer","description":"Time (in seconds) elapsed for a running job before it's cancelled. The minimum value is 1 second.","format":"int64"},"maxTimeInQueue":{"type":"integer","description":"Time to live in the job queue (in seconds)","format":"int64"},"logDebug":{"type":"boolean","description":"Whether the stream will run with debug logging or not"}}},"AutomationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Workflow ID","format":"uuid"},"name":{"type":"string","description":"Workflow name"},"enabled":{"type":"boolean","description":"Whether this workflow is enabled"},"tags":{"type":"array","description":"Associated tags","items":{"type":"string","description":"Associated tags"}},"owner":{"type":"string","description":"Name of the user that owns the automation workflow"},"ownerID":{"type":"string","description":"ID of the user that owns the automation workflow","format":"uuid"},"lastUpdated":{"type":"string","description":"Date when this workflow was last started","format":"date-time"},"logStats":{"$ref":"#/components/schemas/LogStatsResponse"},"runMode":{"type":"string","description":"Determines how messages are logged for the automation. In production mode, messages are logged to files. In debug mode, messages are logged to the DB.","enum":["production","debug"]}},"description":"Items in this results page"},"NewSsoPropertiesRequest":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string","description":"Kerberos authentication ID of service account used for single sign-on authentication. Required when 'authentication' is set to SSO"},"password":{"type":"string","description":"Password of service account used for single sign-on authentication. Required when 'authentication' is set to SSO"}},"description":"SSO user properties"},"SnowflakeAuthResponse":{"type":"object","properties":{"account":{"type":"string","description":"Account to connect to Remote Engine."},"user":{"type":"string","description":"User to connect to Remote Engine."},"role":{"type":"string","description":"Role to connect to Remote Engine."},"endpoint":{"type":"string","description":"Endpoint of the Remote Engine."},"privateKey":{"type":"string","description":"Private key to connect to Remote Engine."},"publicKey":{"type":"string","description":"Public key to connect to Remote Engine."}},"description":"Snowflake configuration for the Remote Engine."},"TestExistingEventGridSubscriptionRequest":{"required":["eventType","subject","subscriberName","topicEndpoint"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"topicEndpoint":{"type":"string","description":"The topic endpoint of the Azure Event Grid Topic"},"topicKey":{"type":"string","description":"The topic access key used to publish events to the Azure Event Grid Topic"},"subject":{"type":"string","description":"The subject used for filtering and routing events"},"eventType":{"type":"string","description":"The event type of the specified subject"},"data":{"type":"string","description":"The event data, specified in key/value pairs, that is published to the specified Azure Event Grid Topic Endpoint."}}}]},"NewS3WatchPublicationRequest":{"required":["accessKeyID","bucket","eventsToWatchFor","name","pollInterval","publisherName","secretAccessKey","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewPublicationRequest"},{"type":"object","properties":{"bucket":{"type":"string","description":"The Bucket name in the Amazon Web Services (AWS) S3 account, case-sensitive"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the S3 Bucket"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the S3 Bucket"},"region":{"type":"string","description":"The region of the specified Amazon Web Services (AWS) S3 Bucket"},"path":{"type":"string","description":"The folder location in the specified Amazon Web Services (AWS) S3 Bucket to watch for changes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified Amazon Web Services (AWS) S3 Bucket. S3 is a pay-per-use service. Every poll is one request to this service.","format":"int32"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"UpdateHttpSubscriptionRequest":{"required":["acceptHeader","contentType","requestType","subscriberName","url","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdateSubscriptionRequest"},{"type":"object","properties":{"requestType":{"type":"string","description":"The type of HTTP request","enum":["get","post","put","delete"]},"url":{"type":"string","description":"The URL to which notifications on the associated topics are delivered via HTTP POST"},"httpUsername":{"type":"string","description":"The username when the target URL requires HTTP authentication"},"httpPassword":{"type":"string","description":"The user password when the target URL requires HTTP authentication"},"acceptHeader":{"type":"string","description":"Format of the Accept request HTTP header: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"contentType":{"type":"string","description":"The format in which to deliver content: JSON (application/json), XML (applicaton/xml), or Text (text/plain). Alternatively, enter your own media type."},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"contentTemplate":{"type":"string","description":"The message body content. If specified, this message replaces the incoming message body."}}}]},"TestExistingUdpPublicationRequest":{"required":["port","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"port":{"type":"integer","description":"The UDP port to listen to for incoming data packets","format":"int32"}}}]},"LicenseFileRequest":{"required":["email","firstName","lastName","subscribeToUpdates"],"type":"object","properties":{"jobTitle":{"type":"string","description":"Job title"},"company":{"type":"string","description":"Company"},"industry":{"type":"string","description":"Industry"},"email":{"type":"string","description":"Email address"},"firstName":{"type":"string","description":"First Name"},"lastName":{"type":"string","description":"Last Name"},"serialNumber":{"type":"string","description":"Serial number"},"subscribeToUpdates":{"type":"boolean","description":"Subscribe to updates"}}},"TagRequest":{"required":["tag"],"type":"object","properties":{"tag":{"type":"string","description":"Name of the tag"}}},"RepositoryResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the repository"},"description":{"type":"string","description":"Description of the repository"},"ownerID":{"type":"string","description":"UUID of the user that owns the repository","format":"uuid"},"owner":{"type":"string","description":"Name of the user that owns the repository"},"shareable":{"type":"boolean","description":"Whether the repository is shareable or not"},"totalFileSize":{"type":"integer","description":"The total size of resource files in bytes","format":"int64"},"fileCount":{"type":"integer","description":"The total number of resource files","format":"int64"},"workspaceCount":{"type":"integer","description":"The total number of workspaces","format":"int64"},"customTransformerCount":{"type":"integer","description":"The total number of custom transformers","format":"int64"},"customFormatCount":{"type":"integer","description":"The total number of custom formats","format":"int64"},"templateCount":{"type":"integer","description":"The total number of templates","format":"int64"}},"description":"Items in this results page"},"RedundantServerRequest":{"required":["host","port"],"type":"object","properties":{"host":{"type":"string","description":"Server host"},"port":{"type":"integer","description":"Server port","format":"int32"}},"description":"Additional LDAP servers used for maintaining high availability."},"LDAPRoleInfoResponse":{"type":"object","properties":{"distinguishedName":{"type":"string","description":"Distinguished name of the LDAP role"},"linkedRoleName":{"type":"string","description":"Linked role name"},"name":{"type":"string","description":"Name of the LDAP user"},"serverName":{"type":"string","description":"Name of the LDAP server"}},"description":"Linked LDAP role information"},"DatabaseConnectionResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the connection"},"category":{"type":"string","description":"The category of the connection","enum":["database","basic","token","oauthV2"]},"type":{"type":"string","description":"The type of the connection"},"owner":{"type":"string","description":"The owner of the connection"},"shareable":{"type":"boolean","description":"Whether the connection is shareable"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"UpdateServicesRequest":{"type":"object","properties":{"fmedatadownload":{"$ref":"#/components/schemas/UpdateDataDownloadRequest"},"fmedatastreaming":{"$ref":"#/components/schemas/UpdateDataStreamingRequest"},"fmejobsubmitter":{"$ref":"#/components/schemas/UpdateJobSubmitterRequest"},"fmekmllink":{"$ref":"#/components/schemas/UpdateKMLNetworkLinkRequest"}}},"DataVirtualizationEndpointAsyncResponse":{"type":"object","properties":{"inheritAsyncProcessing":{"type":"boolean","description":"Whether the endpoint will inherit the asynchronous processing configuration of the API"},"asyncEnabled":{"type":"boolean","description":"Whether asynchronous processing is enabled"},"asyncResultExpiryInSeconds":{"type":"integer","description":"Asynchronous result data expiry in seconds","format":"int64"}},"description":"Asynchronous processing configuration of the endpoint"},"TestExistingSqsPublicationRequest":{"required":["accessKeyID","deleteMessageAfterReceived","publisherName","queueUrl","visibilityTimeout"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"queueUrl":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to pull messages from"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"deleteMessageAfterReceived":{"type":"boolean","description":"Whether to automatically delete the message after it has been received"},"visibilityTimeout":{"maximum":43200,"minimum":0,"type":"integer","description":"The visibility timeout (in seconds) for the Amazon Web Services (AWS) SQS Queue","format":"int32"}}}]},"DataVirtualizationEndpointSecurityResponse":{"type":"object","properties":{"inheritSecurity":{"type":"boolean","description":"Whether the endpoint will inherit the security of the API"},"requireAuthentication":{"type":"boolean","description":"Whether the endpoint requires user authentication to access endpoints"},"allowedUsers":{"type":"array","description":"IDs of users that are authorized to run this endpoint","items":{"$ref":"#/components/schemas/AllowedUserResponse"}},"allowedRoles":{"type":"array","description":"IDs of roles that are authorized to run this endpoint","items":{"$ref":"#/components/schemas/AllowedRoleResponse"}}},"description":"Security configuration for the endpoint"},"TopicMonitoringResponse":{"type":"object","properties":{"internalWebsocketURL":{"type":"string","description":"The internal websocket URL."},"externalWebsocketHost":{"type":"string","description":"The external websocket host."},"externalWebsocketPort":{"type":"integer","description":"The external websocket port.","format":"int32"}}},"EventGridPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"webhookEndpoint":{"type":"string","description":"The WebHook endpoint from which to receive events. The ID parameter acts as an access token to verify that the event is coming from Azure Event Grid and should be kept private. Azure Event Grid only supports publicly accessible HTTPS webhook endpoints using a valid certificate."}}},"UpdateItemPermissionsRequest":{"required":["ownerID"],"type":"object","properties":{"ownerID":{"type":"string","description":"UUID of the owner","format":"uuid"},"rolePermissions":{"type":"array","description":"Role permissions granted for this item","items":{"$ref":"#/components/schemas/RoleItemPermissionRequest"}},"accountPermissions":{"type":"array","description":"Account permissions granted for this item","items":{"$ref":"#/components/schemas/AccountItemPermissionRequest"}},"tokenPermissions":{"type":"array","description":"Token permissions granted for this item","items":{"$ref":"#/components/schemas/TokenItemPermissionRequest"}}}},"UpdateDataVirtualizationApiRequest":{"required":["asyncProcessing","caching","security","title","version"],"type":"object","properties":{"title":{"type":"string","description":"Title of the API"},"version":{"type":"string","description":"Version of the API","example":"1.0.0"},"summary":{"type":"string","description":"Short summary of the API"},"description":{"type":"string","description":"Description of the API"},"queue":{"type":"string","description":"Assigned queue for all jobs run by the API"},"jobExpiryInSeconds":{"minimum":1,"type":"integer","description":"Maximum run time for a job, including its time in a queue, in seconds. The job will be cancelled if it exceeds this duration. Default is 2 minutes.","format":"int64"},"contactName":{"type":"string","description":"Contact person or organization"},"contactURL":{"type":"string","description":"Address pointing to the contact information"},"contactEmail":{"type":"string","description":"Email address of the contact person or organization"},"security":{"$ref":"#/components/schemas/DataVirtualizationApiSecurityRequest"},"caching":{"$ref":"#/components/schemas/DataVirtualizationApiCachingRequest"},"asyncProcessing":{"$ref":"#/components/schemas/DataVirtualizationApiAsyncRequest"}}},"UpdateJmsPublicationRequest":{"required":["connectionFactory","destinations","publisherName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."}}}]},"Resource":{"type":"object","properties":{"name":{"type":"string","description":"Unique name of the resource"},"size":{"type":"integer","description":"Amount of storage on the server the resource file occupies","format":"int64"}},"description":"Resources belonging to and used by the item"},"TestExistingEmailSubscriptionRequest":{"required":["emailContentType","emailFrom","emailSubject","emailTo","smtpServer","smtpServerPort","smtpServerSecurity","subscriberName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"smtpServer":{"type":"string","description":"The mail exchange server domain name or IP address"},"smtpServerPort":{"type":"integer","description":"The mail exchange TCP port","format":"int32","example":25},"smtpServerAccount":{"type":"string","description":"The username when SMTP server requires authentication"},"smtpServerPassword":{"type":"string","description":"The user or app password when SMTP server requires authentication"},"smtpServerSecurity":{"type":"string","description":"The encryption mechanism used for the connection","enum":["sslTls","startTls","none"]},"emailTo":{"type":"array","description":"The Email recipient(s)","items":{"type":"string","description":"The Email recipient(s)"}},"emailCc":{"type":"array","description":"The Email cc recipient(s)","items":{"type":"string","description":"The Email cc recipient(s)"}},"emailBcc":{"type":"array","description":"The Email bcc recipient(s)","items":{"type":"string","description":"The Email bcc recipient(s)"}},"emailFrom":{"type":"string","description":"The \"From\" field in standard Email messages. If users reply to the notification email, it is directed to this address."},"emailSubject":{"type":"string","description":"The subject of the Email"},"emailContentType":{"type":"string","description":"The format of the Email","enum":["text","html","richText"]},"emailAttachment":{"type":"array","description":"The path to the source file to attach to the Email","items":{"type":"string","description":"The path to the source file to attach to the Email"}},"emailTemplate":{"type":"string","description":"The message body to use for delivery. See documentation for supported tags."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}}]},"EnablePasswordPolicyRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates whether password complexity rules are applied"}}},"RolePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/RoleResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"TestExistingDropboxWatchPublicationRequest":{"required":["eventsToWatchFor","path","publisherName","watchSubdirectories"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingPublicationRequest"},{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token for the Dropbox account"},"accessTokenExpiry":{"type":"integer","description":"The access token expiry time in milliseconds since epoch","format":"int64"},"refreshToken":{"type":"string","description":"The app key associated with the Dropbox account"},"appKey":{"type":"string","description":"The app secret associated with the Dropbox account"},"appSecret":{"type":"string","description":"The app secret associated with the Dropbox account"},"path":{"type":"string","description":"The location on your Dropbox account to watch for changes, specified using forward slashes"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}}}}]},"LdapServerConnectionOptionsRequest":{"required":["searchUser","searchUserPassword"],"type":"object","properties":{"searchUser":{"type":"string","description":"Distinguished name of service account used for searches"},"searchUserPassword":{"type":"string","description":"Password of service account used for searches"},"redundantServers":{"uniqueItems":true,"type":"array","description":"Additional LDAP servers used for maintaining high availability.","items":{"$ref":"#/components/schemas/RedundantServerRequest"}}},"description":"LDAP server connection options"},"TokenResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the token","format":"uuid"},"name":{"type":"string","description":"Name of the token"},"description":{"type":"string","description":"Description of the token"},"ownerID":{"type":"string","description":"UUID of the user that owns the token","format":"uuid"},"owner":{"type":"string","description":"Name of the user that owns the token"},"type":{"type":"string","description":"Token type","enum":["api","session"]},"customPermissions":{"type":"boolean","description":"Whether the token has custom permissions; if false, the token has the same permissions as the token owner"},"enabled":{"type":"boolean","description":"Whether the token is enabled or not"},"created":{"type":"string","description":"Date/time when the token was created","format":"date-time"},"updated":{"type":"string","description":"Date/time when the token was last updated","format":"date-time"},"secondsToExpiry":{"type":"integer","description":"Seconds until the token expires","format":"int64"},"expiration":{"type":"string","description":"Expiration date/time of the token in ISO-8601 format with timezone 'Z' for zero UTC offset","format":"date-time"}},"description":"Items in this results page"},"ProjectExportRequest":{"type":"object","properties":{"includeSensitiveInfo":{"type":"boolean","writeOnly":true},"skipValidation":{"type":"boolean","writeOnly":true},"skipMissingItems":{"type":"boolean","writeOnly":true},"exportPackageName":{"type":"string","writeOnly":true},"selectedItems":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/ItemId"}},"excludeAllSelectableItems":{"type":"boolean","writeOnly":true}}},"EnableEngineRuleRequest":{"required":["enabled"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates if engine rule is enabled"}}},"AccountResponse":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the account","format":"uuid"},"name":{"type":"string","description":"Unique name of the account"},"fullName":{"type":"string","description":"Full name of the account user"},"email":{"type":"string","description":"Email of the account user"},"roles":{"type":"array","description":"Roles assigned to the account","items":{"$ref":"#/components/schemas/AccountRoleAssignmentResponse"}},"isSuperUser":{"type":"boolean","description":"Whether the account has elevated permissions allowed to perform any operation of FME Flow"},"enabled":{"type":"boolean","description":"Whether the account is enabled or not"},"sharingEnabled":{"type":"boolean","description":"Whether the account is allowed to share items with other users and roles"},"type":{"type":"string","description":"Type of the account","enum":["system","ldap","azure","saml"]},"password":{"type":"string","description":"Password of the account user (this is a sensitive field and will always return `null`)"},"passwordChangeNeeded":{"type":"boolean","description":"Whether to require changing of password on next login"},"passwordExpired":{"type":"boolean","description":"Whether the account password is expired"}}},"NewJmsSubscriptionRequest":{"required":["connectionFactory","deliveryMode","destinations","name","subscriberName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."},"deliveryMode":{"type":"string","description":"Whether messages are stored by the JMS broker until the message is delivered to a destination, and can be recovered in the event of a broker restart","enum":["persistent","nonPersistent"]},"contentTemplate":{"type":"string","description":"The message body"}}}]},"FeatureType":{"type":"object","properties":{"attributes":{"type":"array","description":"Attributes defined for the feature type","items":{"$ref":"#/components/schemas/Attribute"}},"description":{"type":"string","description":"A human-readable description of the feature type"},"name":{"type":"string","description":"Unique name of the feature type"},"properties":{"type":"array","description":"Properties defined for this dataset","items":{"$ref":"#/components/schemas/Property"}}},"description":"FME feature types belonging to this dataset"},"NewFtpSubscriptionRequest":{"required":["connectionType","encryption","host","name","port","subscriberName","transferType","verifyCertificate"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"host":{"type":"string","description":"The FTP host name"},"port":{"type":"integer","description":"The FTP port number","format":"int32","example":21},"username":{"type":"string","description":"The FTP user name for authentication. A null or empty value will be replaced with \"anonymous\"."},"password":{"type":"string","description":"The FTP user password for authentication"},"encryption":{"type":"string","description":"The encryption type, depending on the FTP server connection requirements","enum":["none","ftps","ftpes"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"transferType":{"type":"string","description":"The transfer method","enum":["auto","ascii","binary"]},"connectionType":{"type":"string","description":"The FTP connection mode","enum":["passive","active"]},"localSourcePath":{"type":"string","description":"The path to the source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"remoteUploadDirectory":{"type":"string","description":"The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."}}}]},"ImapPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"imapServer":{"type":"string","description":"The mail exchange server domain name or IP address used for receiving email"},"imapPort":{"type":"integer","description":"The mail exchange TCP port used for receiving email","format":"int32"},"imapAccount":{"type":"string","description":"The email account used for receiving email over IMAP. IMAP access must be enabled on this account. You cannot create multiple IMAP Publishers that reference the same address."},"imapPassword":{"type":"string","description":"The email account password used for receiving email over IMAP"},"imapSecurity":{"type":"string","description":"The encryption mechanism used for the IMAP connection","enum":["sslTls","startTls","none"]},"verifyCertificate":{"type":"boolean","description":"Whether the connection is verified with a valid, signed certificate"},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll from the specified IMAP server for email","format":"int32"},"fetchOption":{"type":"string","description":"Whether to fetch all unread messages from the inbox or only messages received after the previous fetch","enum":["newEmailsOnly","unreadEmails"]},"filterType":{"type":"string","description":"The filter, case-insensitive string match or regular expression, against the email subject line","enum":["simple","regex"]},"subjectFilter":{"type":"string","description":"Only fetch messages where the subject satisfies the filter. Wildcard characters are not supported. If the filter is left blank, then all unread/new messages will be fetched."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escaped backslashes (\\\\\\\\)."},"clientID":{"type":"string","description":"The client ID when Microsoft OAuth is used"}}},"TestExistingJmsSubscriptionRequest":{"required":["connectionFactory","deliveryMode","destinations","subscriberName","type","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestExistingSubscriptionRequest"},{"type":"object","properties":{"type":{"type":"string","description":"The message broker to connect to, or the initial context factory if the broker is not listed","example":"WEBSPHERE70"},"url":{"type":"string","description":"The URL of the directory containing connection details for the JMS provider"},"providerProperties":{"type":"string","description":"Any additional provider-specific properties, in the form key=value"},"connectionFactory":{"type":"string","description":"The name of the connection factory object"},"username":{"type":"string","description":"The authenticating username"},"password":{"type":"string","description":"The authenticating password"},"destinations":{"type":"string","description":"The name(s) of the destination object(s), separated with commas. These correspond to queues and/or topics."},"deliveryMode":{"type":"string","description":"Whether messages are stored by the JMS broker until the message is delivered to a destination, and can be recovered in the event of a broker restart","enum":["persistent","nonPersistent"]},"contentTemplate":{"type":"string","description":"The message body"}}}]},"SystemEventsHistoryPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/SystemEventsHistoryResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"RoleItemPermissionRequest":{"required":["id","permissions"],"type":"object","properties":{"id":{"type":"string","description":"UUID of the role","format":"uuid"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}},"description":"Role permissions granted for this item"},"DirWatchPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"directory":{"type":"string","description":"The directory to watch for activity"},"watchSubdirectories":{"type":"boolean","description":"Whether to watch activity in the selected directory and all subdirectories"},"watchFolder":{"type":"boolean","description":"Whether to monitor activities on only files or both files and folders"},"eventsToWatchFor":{"type":"array","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","items":{"type":"string","description":"The actions (CREATE, MODIFY, and/or DELETE), on the specified directory that will trigger a notification","enum":["create","modify","delete"]}},"pollInterval":{"type":"integer","description":"How often, in seconds, to poll the specified Directory to watch for activity. In order to ensure the whole file has been transferred before publishing a notification, it will take an additional poll interval after the transfer has finished for the notification to appear","format":"int32"}}},"StreamEngineRuleResponse":{"type":"object","properties":{"type":{"type":"string","description":"Type of engine assignment rule","enum":["name","property"]},"name":{"type":"string","description":"Name of engine assignment rule"},"rule":{"type":"string","description":"Engine assignment rule"},"queues":{"type":"array","description":"Queues to assign engines to","items":{"type":"string","description":"Queues to assign engines to"}},"enabled":{"type":"boolean","description":"Indicates if engine assignment rule is enabled"}}},"TagPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/TagResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"SystemEventsConfigurationRequest":{"required":["enabled","properties","sendEmail"],"type":"object","properties":{"sendEmail":{"type":"boolean","description":"Whether the configuration will send an email for each event"},"properties":{"type":"object","additionalProperties":{"type":"string","description":"Properties of the configuration"},"description":"Properties of the configuration"},"enabled":{"type":"boolean","description":"Whether the configuration is enabled or not"}}},"TopicMonitoringURLRequest":{"required":["url"],"type":"object","properties":{"url":{"type":"string","description":"The internal websocket URL to set."}}},"MigrationRestoreResourceRequest":{"required":["overwrite","packagePath","pauseNotifications","resourceName"],"type":"object","properties":{"resourceName":{"type":"string","description":"Name of the resource connection"},"packagePath":{"type":"string","description":"Path of the package to import"},"overwrite":{"type":"boolean","description":"Whether the system restore should overwrite items if they already exist"},"pauseNotifications":{"type":"boolean","description":"Whether the system restore should pause FME Flow notifications"},"successTopic":{"type":"string","description":"Topic to notify on successful system restore"},"failureTopic":{"type":"string","description":"Topic to notify on failed system restore"}}},"ItemPermissionResponse":{"type":"object","properties":{"category":{"type":"string","description":"Category of the item"},"name":{"type":"string","description":"Name of the item"},"displayName":{"type":"string","description":"Display name of the item"},"ownerName":{"type":"string","description":"Name of the owner"},"ownerID":{"type":"string","description":"UUID of the owner","format":"uuid"},"permissions":{"type":"array","description":"Permissions granted for this item","items":{"type":"string","description":"Permissions granted for this item"}}},"description":"Items in this results page"},"NewSnsSubscriptionRequest":{"required":["accessKeyID","name","secretAccessKey","subscriberName","topicArn"],"type":"object","allOf":[{"$ref":"#/components/schemas/NewSubscriptionRequest"},{"type":"object","properties":{"topicArn":{"type":"string","description":"The ARN of the Amazon Web Services (AWS) SNS Topic"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SNS Topic"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SNS Topic"},"subject":{"type":"string","description":"The subject of the Amazon Web Services (AWS) SNS Topic"},"contentTemplate":{"type":"string","description":"The default message to publish to the Amazon Web Services (AWS) SNS Topic. Can be up to 64 KB of Unicode text."}}}]},"ImportRoleRequest":{"required":["distinguishedName","roleName"],"type":"object","properties":{"roleName":{"type":"string","description":"Name of the FME Flow role"},"distinguishedName":{"type":"string","description":"Distinguished name of the LDAP role"}}},"TestSqsPublicationRequest":{"required":["accessKeyID","deleteMessageAfterReceived","publisherName","queueUrl","secretAccessKey","visibilityTimeout"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"queueUrl":{"type":"string","description":"The URL of the Amazon Web Services (AWS) SQS Queue to pull messages from"},"accessKeyID":{"type":"string","description":"The Amazon Web Services (AWS) Access Key ID for the account that owns the SQS Queue"},"secretAccessKey":{"type":"string","description":"The Amazon Web Services (AWS) Secret Access Key for the account that owns the SQS Queue"},"deleteMessageAfterReceived":{"type":"boolean","description":"Whether to automatically delete the message after it has been received"},"visibilityTimeout":{"maximum":43200,"minimum":0,"type":"integer","description":"The visibility timeout (in seconds) for the Amazon Web Services (AWS) SQS Queue","format":"int32"}}}]},"TokenPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/TokenResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"JobCountIntervalPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/JobCountInterval"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"StreamRemoteConfig":{"type":"object","properties":{"remoteEngineID":{"type":"string","description":"Identifier of the Remote Engines Service that is assigned to the stream","format":"uuid"}},"description":"Configuration for remote stream"},"ChoiceSettings":{"required":["choiceSet"],"type":"object","properties":{"choiceSet":{"type":"string","description":"Choice set","enum":["dbConnections","webConnections"]},"services":{"type":"array","description":"Included services","items":{"type":"string","description":"Included services"}},"excludedServices":{"type":"array","description":"Excluded services","items":{"type":"string","description":"Excluded services"}},"family":{"type":"string","description":"Database family"}},"description":"Choice settings"},"ServerStatusResponse":{"type":"object","properties":{"status":{"type":"string","description":"Current LDAP server status","enum":["unavailable","pending","available"]},"statusMessage":{"type":"string","description":"Message pertaining to the current LDAP server status"}},"description":"Status of the LDAP server"},"SAMLConfigPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/SAMLConfigResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"NewJobRuleRequest":{"required":["enabled","name","queue","rule","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of job routing rule"},"type":{"type":"string","description":"Type of job routing rule","enum":["repository","property"]},"rule":{"type":"string","description":"Job routing rule"},"queue":{"type":"string","description":"Queue to route job to"},"enabled":{"type":"boolean","description":"Indicates if job routing rule is enabled"}}},"SnsPublicationResponse":{"type":"object","properties":{"ownerID":{"type":"string","description":"ID of the owner of the publication","format":"uuid"},"owner":{"type":"string","description":"Owner of the publication"},"name":{"type":"string","description":"Name of the publication"},"publisherName":{"type":"string","description":"The communication protocol used for the publication"},"shareable":{"type":"boolean","description":"Whether the publication is shareable or not"},"topics":{"type":"array","description":"Set of assigned topics","items":{"type":"string","description":"Set of assigned topics"}},"successTopics":{"type":"array","description":"Set of topics to notify upon successful execution","items":{"type":"string","description":"Set of topics to notify upon successful execution"}},"failureTopics":{"type":"array","description":"Set of topics to notify upon failed execution","items":{"type":"string","description":"Set of topics to notify upon failed execution"}},"subscriptionArn":{"type":"string","description":"The Amazon Web Services (AWS) SNS Subscription ID"}}},"TestWebSocketSubscriptionRequest":{"required":["streamID","subscriberName","url"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestSubscriptionRequest"},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the WebSocket server","example":"ws://localhost:8080/websocket"},"streamID":{"type":"string","description":"The stream ID used to uniquely identify message streams and connect them to the right requesting applications."},"template":{"type":"string","description":"The message sent in the stream"}}}]},"JobRulePage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/JobRuleResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"DataVirtualizationTagPage":{"type":"object","properties":{"items":{"type":"array","description":"Items in this results page","items":{"$ref":"#/components/schemas/DataVirtualizationTagResponse"}},"totalCount":{"type":"integer","description":"Total amount of items available","format":"int64"},"limit":{"type":"integer","description":"Limit of this results page","format":"int64"},"offset":{"type":"integer","description":"Offset of this results page","format":"int64"}}},"UpdateBroadcastMessageRequest":{"required":["message","severity","title"],"type":"object","properties":{"message":{"type":"string","description":"Message to broadcast"},"title":{"type":"string","description":"Title of the broadcast message"},"severity":{"type":"string","description":"Severity of the broadcast message","enum":["info","warn","critical"]},"enabled":{"type":"boolean","description":"Whether the broadcast message is enabled or not"}}},"CleanupTaskResponse":{"type":"object","properties":{"name":{"type":"string","description":"Name of the cleanup task"},"category":{"type":"string","description":"Category the cleanup task is associated with"},"maxAgeInSeconds":{"type":"integer","description":"Maximum age (seconds) of files to keep before cleaning","format":"int64"},"description":{"type":"string","description":"Description of the cleanup task"},"enabled":{"type":"boolean","description":"Whether the cleanup task is currently enabled or disabled"},"filter":{"$ref":"#/components/schemas/CleanupTaskFilter"},"sourceResourceConnection":{"type":"string","description":"The resource connection where the desired files to cleanup will be found, e.g. \"FME_SHAREDRESOURCE_LOG\""},"sourcePath":{"type":"string","description":"The path (from the resource connection) to process files from, e.g. \"automations/old\", with no trailing or leading slashes"}},"description":"Items in this results page"},"UpdateSmtpPublicationRequest":{"required":["emailUserName","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/UpdatePublicationRequest"},{"type":"object","properties":{"emailUserName":{"type":"string","description":"The username of the email address on the FME Flow host system that receives the notification email. For example, if the FME Flow host name is services.internal, and the email address is user@services.internal, enter user."},"attachmentPath":{"type":"string","description":"The location to download any attachments. File paths must use forward slashes (/) or escapedbackslashes (\\\\\\\\)."}}}]},"RenameRequest":{"required":["currentName","newName","path"],"type":"object","properties":{"path":{"type":"string","description":"Directory, relative to the resource connection (for example, /foo/bar)."},"currentName":{"type":"string","description":"File or folder to be renamed."},"newName":{"type":"string","description":"New name of the file or folder."}}},"CleanupTaskFilter":{"required":["matcher","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of filter used to match against filenames","enum":["endsWith","notEndsWith"]},"matcher":{"type":"string","description":"The string to match against"}},"description":"If filter is provided, only filenames that match the filter at the source location will be cleaned up"},"JobIDResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for this job","format":"int64"}}},"TestUdpPublicationRequest":{"required":["port","publisherName"],"type":"object","allOf":[{"$ref":"#/components/schemas/TestPublicationRequest"},{"type":"object","properties":{"port":{"type":"integer","description":"The UDP port to listen to for incoming data packets","format":"int32"}}}]},"NewCleanupTaskRequest":{"required":["category","enabled","maxAgeInSeconds","name","sourcePath","sourceResourceConnection"],"type":"object","properties":{"name":{"type":"string","description":"Name of the cleanup task"},"category":{"type":"string","description":"Category the cleanup task is associated with"},"maxAgeInSeconds":{"minimum":0,"type":"integer","description":"Maximum age (seconds) of files, jobs, system events, or tokens to keep before cleaning","format":"int64"},"description":{"type":"string","description":"Description of the cleanup task"},"enabled":{"type":"boolean","description":"Whether the cleanup task is currently enabled or disabled"},"filter":{"$ref":"#/components/schemas/CleanupTaskFilter"},"sourceResourceConnection":{"type":"string","description":"The resource connection where the desired files to cleanup will be found, e.g. \"FME_SHAREDRESOURCE_LOG\""},"sourcePath":{"type":"string","description":"The path (from the resource connection) to process files from, e.g. \"automations/old\", with no trailing or leading slashes"}}}}}}